Workspaces

A workspace is a container for bug reports, spaces, and team members within your organization.

Response fields

FieldTypeDescription
idstringUnique workspace ID
namestringWorkspace name
slugstring | nullURL-friendly slug
createdAtstringISO 8601 timestamp
updatedAtstringISO 8601 timestamp

List workspaces

GET /v1/workspaces

Scope: workspaces:read

Returns all workspaces you have access to. WST tokens only see their scoped workspace.

ParameterTypeDescription
sortstringSort field (default: createdAt)
orderstringasc or desc (default: desc)
cursorstringPagination cursor
limitnumberResults per page, 1–100 (default: 25)

Get a workspace

GET /v1/workspaces/:id

Scope: workspaces:read

Create a workspace

POST /v1/workspaces

Scope: workspaces:write — PAT tokens only (WST cannot create workspaces)

FieldTypeRequiredDescription
namestringYesWorkspace name (max 80 chars)
descriptionstringNoWorkspace description

Update a workspace

PATCH /v1/workspaces/:id

Scope: workspaces:write — Requires ADMIN role on the workspace

FieldTypeDescription
namestringUpdated name
descriptionstringUpdated description