Skip to content

List Workspaces

GET
/v1/workspaces

List the workspaces this API key can access.

Workspace-bound key: just its workspace. Org-scoped key: all workspaces the creator can access.

Successful Response

Response List Workspaces V1 Workspaces Get
Array<object>
UserWorkspaceResponseSchema

Workspace response enriched with user-relative context.

object
workspace_id
required
Workspace Id
integer
owner_id
required
Owner Id
string format: uuid
org_id
required
Org Id
string format: uuid
workspace_type_id
Any of:
integer
name
required
Name
string
description
required
Any of:
string
summary
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
is_public
required
Is Public
boolean
valid_until
Any of:
string format: date-time
index_frozen
Index Frozen
boolean
artifact_count
Artifact Count
integer
0
latest_artifact_at
Any of:
string format: date-time
is_external
Is External
boolean