Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

workspaceId
string
required

The workspace id.

Body

application/json
inviteCode
any
name
any
slug
any

Response

200 - application/json
creatorId
string | null
required

The workspace creator id.

dateCreated
string
required

The workspace creation date.

dateUpdated
string
required

The workspace last updated date.

id
string
required

The workspace id.

inviteCount
integer
required

The number of invites in the workspace.

Required range: x > 0
memberCount
integer
required

The number of members in the workspace.

Required range: x > 0
name
string
required

The workspace name.

Maximum length: 80
periodEndDate
string | null
required

The end date of the current billing period.

periodStartDate
string | null
required

The start date of the current billing period.

projectCount
integer
required

The number of projects in the workspace.

Required range: x > 0
slug
string
required

The workspace slug.

Maximum length: 32
status
enum<string>
required
Available options:
active,
past_due,
unpaid,
canceled,
incomplete,
incomplete_expired,
trialing,
paused
monthlyUsage
object[]
samlOnlyAccess
boolean

Whether the workspace only allows SAML authentication.

wildcardDomains
string[]