Skip to main content
GET
Retrieve a workspace

Authorizations

Authorization
string
header
required

Enter your JWT in the format: Bearer {token}

Path Parameters

workspaceId
string
required

The ID of the workspace.

Example:

"ws_a1b2c3d4e5f6g7h8"

Response

The requested workspace object.

id
string

Unique identifier for the workspace, prefixed with ws_.

Example:

"ws_a1b2c3d4e5f6g7h8"

name
string

The name of the workspace.

Example:

"ACME Corporation"

description
string | null

An optional description for the workspace.

Example:

"Primary workspace for all ACME projects."

billing_mode
enum<string>

The billing mode for the workspace. Determines how subscriptions and usage are handled.

Available options:
single,
assigned,
pooled
Example:

"pooled"

pooled_seat_limit
integer | null

The total number of seats available in 'pooled' billing mode. This is null for other modes.

Example:

100

archived
boolean

Whether the workspace is archived.

Example:

false

created_at
string<date-time>

The timestamp when the workspace was created.

Example:

"2025-10-29T00:40:06.000000Z"

updated_at
string<date-time>

The timestamp when the workspace was last updated.

Example:

"2025-10-29T00:40:06.000000Z"

archived_at
string<date-time> | null

The timestamp when the workspace was archived.

Example:

null