Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Workspace

List Workspaces

List workspaces for a team

get/teams/{team_id}/workspaces

Path parameters

team_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at' | 'name'

Sort property of the workspace list. Defaults to id; updated_at and name are also supported.

Response

OK

idinteger

Workspace ID

public_idstring nullable

Workspace public ID

team_idinteger

Team ID

namestring

Workspace Name

subdomainstring

Subdomain

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

[
  {
    "id": 42000,
    "public_id": "CblaAF",
    "team_id": 42000,
    "name": "Example Workspace",
    "subdomain": "example",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]