Skip to main content
GET
Get a workspace

Authorizations

Authorization
string
header
required

Account API key: key id as the username, secret as the password.

Path Parameters

workspace_id_or_name
string
required

Response

Successful response

id
string<uuid>
created_at
string<date-time>
updated_at
string<date-time>
creator_id
string<uuid>
name
string
Maximum string length: 100
owner_id
string<uuid>

The account that owns this entity.

restrict_account_credentials
boolean

When true, tasks in this workspace may not fall back to the owning account's shared credential pool: a resolution that would reach the account default is refused so the workspace must rely on credentials granted or connected to its agents.

should_restrict_members
boolean

When true, only workspace members (plus org admins of the owning org) can access this workspace; when false, it is open to the whole owning org.

unlimited_power_mode
boolean

When true, this workspace's execution-tree fan-out limits are raised to the platform ceilings instead of the default budgets. The limits are raised, not removed. https://i.ibb.co/5XsvmfKg/CFD5-C99-C-B322-46-A2-9892-AFDF484-D28-E1-1.webp

archived_at
string<date-time> | null
archived_by_id
string<uuid> | null
required_credentials_mode
enum<string> | null

Whose credentials agents in this workspace may run with: SHARED = only org-side credentials serve, MEMBER = only the acting member's own. Unset = no requirement. A workspace agent's own declaration overrides this one.

Available options:
SHARED,
MEMBER
archived_by
any
creator
any
full_name
string

Full workspace name in format "owner_name~workspace_name"

is_viewer_member
any
members_enabled
any
owner
object
unlimited_power_mode_enabled
any