List All Workspaces

List all workspaces for the authenticated user

Returns all workspaces across all projects for the authenticated user.

Authentication

Requires a valid Bearer token.

Response

workspaces · array

List of workspace objects.

Show Workspace object

id · string · required

Unique workspace identifier (UUID).

project_id · string · required

ID of the parent project.

status · string · required

Current workspace status: creating, starting, running, stopping, stopped, error.

hardware · object · required

Hardware configuration.

keep_active · boolean · required

Whether the workspace should stay running when idle.

machine_id · string

Machine ID when provisioned.

private_ip · string

Private IP address within the internal network.

git_ref · string

Current git reference in the workspace.

preview_token · string

Token for accessing workspace preview URLs.

error_message · string

Error details if status is error.

created_at · string · required

ISO 8601 timestamp.

updated_at · string · required

ISO 8601 timestamp.

200

{
  "workspaces": [
    {
      "id": "b2c3d4e5-6789-01ab-cdef-234567890abc",
      "project_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "status": "running",
      "hardware": {
        "cpu_kind": "shared",
        "cpus": 2,
        "memory_mb": 2048,
        "volume_size_gb": 10,
        "gpu_kind": null
      },
      "keep_active": false,
      "machine_id": "d8901234abcd",
      "private_ip": "10.0.0.2",
      "git_ref": "main",
      "preview_token": "ptk_abc123",
      "error_message": null,
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T11:00:00Z"
    }
  ]
}

Errors

Status	Description
401	Unauthorized — missing or invalid token