Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API key authentication. Pass Authorization: Bearer ek_live_xxxxx on every request.

Path Parameters

ws
required
Required string length: 2 - 48
Pattern: ^[a-z0-9-]+$

Response

200 - application/json

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
workspaceId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
user
object
required
role
enum<string>
required
Available options:
admin,
developer,
member
status
enum<string>
required
Available options:
invite-sent,
account-created,
declined,
expired
isOwner
boolean
required
scope
object
required
invitedAt
string<date-time>
required