Sign in

v1

latestOpenAPI 3.0.32026-07-22194221292.5 KB
workspaces

List accessible workspaces

Returns all workspaces the authenticated user has access to. Each workspace is a separate tenant with its own resources, team members, and billing.

get/workspaces

Response

successful operation

createdAtstring

The date and time when the resource was created

updatedAtstring

The date and time when the resource was updated

createdBystring

The user or service account who created the resource

updatedBystring

The user or service account who updated the resource

accountIdstring

Workspace account id

displayNamestring

Workspace display name

idstring

Autogenerated unique workspace id

labelsMetadataLabels

Key-value pairs for organizing and filtering resources. Labels can be used to categorize resources by environment, project, team, or any custom taxonomy.

namestring

Workspace name

regionstring

Workspace write region

resourceCountsobject

Per-resource counts (agents, functions, models, sandboxes, policies, jobs, volumes, drives, volumetemplates, integrationconnections, previews, customdomains, serviceaccounts, images). Only populated when GetWorkspace is called with ?countResources=true.

status'created' | 'account_binded' | 'account_configured' | 'workspace_configured' | 'ready' | 'error'

Workspace status (created, account_binded, account_configured, workspace_configured, ready, error)

statusReasonstring

Reason for current status (only set for error status)

Example response

[
  {
    "displayName": "My Workspace",
    "groupMappings": [
      {
        "groupName": "Engineering",
        "role": "admin"
      }
    ],
    "name": "my-workspace",
    "region": "us-west-2",
    "runtime": {
      "generation": "mk3"
    },
    "status": "ready"
  }
]