​
Arguments

idOrSlug
string
required

The unique ID or slug of the workspace.

name
string

The name of the workspace.

slug
string

The slug of the workspace.

​
Response

id
string
required

The unique ID of the workspace.

name
string
required

The name of the workspace.

slug
string
required

The slug of the workspace.

logo
string | null
required

The logo of the workspace.

usage
number
required

The usage of the workspace.

usageLimit
number
required

The usage limit of the workspace.

linksUsage
number
required

The links usage of the workspace.

linksLimit
number
required

The links limit of the workspace.

domainsLimit
number
required

The domains limit of the workspace.

tagsLimit
number
required

The tags limit of the workspace.

usersLimit
number
required

The users limit of the workspace.

plan
string
required

The plan of the workspace.

stripeId
string | null
required

The Stripe ID of the workspace.

billingCycleStart
number
required

The date and time when the billing cycle starts for the workspace.

createdAt
string
required

The date and time when the workspace was created.

users
object[]
required

The role of the authenticated user in the workspace.

domains
object[]
required

The domains of the workspace.

Was this page helpful?

GetCreate