Sign in

v1

latestOpenAPI 3.0.32026-07-223120123.1 KB

Retrieve a workspace by its ID.

Retrieve a workspace by its ID.

get/workspaces/{workspaceId}

Path parameters

workspaceIdstring uuid required

The workspace id.

Response

Response OK.

idstring uuid required

The workspace id.

namestring required

The workspace name.

slugstring required

The workspace slug.

dateCreatedstring date-time required

The workspace creation date.

dateUpdatedstring date-time required

The workspace last updated date.

creatorIdstring uuid nullable required

The workspace creator id.

inviteCodestring

The workspace invite code.

wildcardDomainsstring[]
projectCountinteger required

The number of projects in the workspace.

memberCountinteger required

The number of members in the workspace.

inviteCountinteger required

The number of invites in the workspace.

periodStartDatestring date-time nullable required

The start date of the current billing period.

periodEndDatestring date-time nullable required

The end date of the current billing period.

samlOnlyAccessboolean

Whether the workspace only allows SAML authentication.

status'active' | 'past_due' | 'unpaid' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'trialing' | 'paused' required

Example response

{
  "name": "Openlayer",
  "slug": "openlayer"
}