Skip to main content
GET
/
workspaces
/
{workspaceId}
Retrieve a workspace
curl --request GET \
  --url https://api.altostrat.io/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "ws_a1b2c3d4e5f6g7h8",
  "name": "ACME Corporation",
  "description": "Primary workspace for all ACME projects.",
  "billing_mode": "pooled",
  "pooled_seat_limit": 100,
  "archived": false,
  "created_at": "2025-10-29T00:40:06.000000Z",
  "updated_at": "2025-10-29T00:40:06.000000Z",
  "archived_at": null
}

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