Workspaces

List workspaces (API keys: their project; users: their organizations)

By default only persistent standard workspaces; lifetime and purpose (each also any) show sessions, drafts and test instances. Ended sessions are tombstones: add include_deleted=true.

get/v1/workspaces

Request

  • Base URL: https://api.shardflux.dev
  • URL: https://api.shardflux.dev/v1/workspaces
  • Auth: HTTP bearer

Query parameters

limitinteger
cursorstring
organization_idstring uuid

UUIDv7, lowercase canonical form.

project_idstring uuid

UUIDv7, lowercase canonical form.

state'creating' | 'starting' | 'running' | 'suspending' | 'suspended' | 'resuming' | 'forking' | 'stopping' | 'failed' | 'deleting' | 'deleted'

Observed state filter.

desired_state'running' | 'suspended' | 'deleted'
key_prefixstring
labelsstring

JSON object of exact label matches; all pairs must match.

include_deletedboolean
lifetime'persistent' | 'session' | 'any'

persistent (default), session or any. Key lookups pass any.

purpose'standard' | 'template_draft' | 'template_test' | 'any'

standard (default), template_draft, template_test or any. Key lookups pass any.

Response

Default Response

next_cursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.