DOCUMENTATIONv2

GET

Workspace Management

Get available workspaces

/api/v2/workspaces

AUTHENTICATIONBearer token · workspaces:readAUTHORITATIVE OWNERidentity-service · identity-workspaceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Discover the workspace boundaries the authenticated account is currently allowed to enter.

WHEN THIS CALL IS USEFUL

Call this before showing a workspace picker, restoring a saved workspace choice, or starting any workflow that must be scoped to a team, treasury, trading desk, or personal context.

OUTCOME · Discover

What changes

Returns active memberships only. It does not select a workspace or change access.

WHY IT MATTERS

Builds a safe context switcher without exposing another user’s memberships.
Lets clients distinguish personal, team, treasury, trading, and contract operating boundaries before loading sensitive state.

ISOLATION + AUTHORITY

Identity derives the subject and tenant from the bearer. The collection cannot enumerate another user, tenant, or inactive membership, and it contains no invitation tokens or wallet secrets.

BEFORE YOU CALL

A bearer token with workspaces:read.
An active Identity account; no workspace identifier is supplied by the caller.

WHAT TO DO NEXT

Read one workspace for its current policy and role.
Select an eligible workspace with PUT /api/v2/me/active-workspace.

AGENT GUIDANCE

Use only workspace_id values returned for the current subject; never guess or reuse an identifier learned from another account.
Treat purpose, isolation policy, role, and status as decision inputs—not as permission to perform an unrelated wallet or administrative action.
If a previously cached workspace disappears, stop the scoped workflow and ask the user to choose from the fresh list.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the workspaces:read scope.EXAMPLEBearer hc_live_…

STABLE ERROR CODES

Branch on the code, then follow the recovery action

These codes are published by the authoritative gateway contract for this endpoint. Treat message as safe diagnostic text; integrations should branch on code and HTTP status.

STATUSCODEMEANING

400invalid_jsonThe JSON body is malformed or fails the published identity schema.

400invalid_security_requestThe identity, workspace, permission, or key request is invalid.

400missing_idempotency_keyA nonempty Idempotency-Key is required for this mutation.

401invalid_credentialsThe bearer or proof-of-possession credential is invalid.

403step_up_requiredThe caller lacks role authority or fresh purpose-bound approval.

404workspace_resource_not_foundThe requested workspace, membership, or invitation was not found.

409security_conflictThe requested permission or identity transition conflicts with current state.

503identity_security_unavailableThe authoritative Identity security service is temporarily unavailable.

RESPONSES

Status and payload examples

200All active workspace memberships visible to the authenticated subject.Read completed · JSON RESPONSE+

{
  "items": [
    {
      "workspace_id": "b00dc220da8f480d86cdc11341372746",
      "tenant_uuid": "b00dc220da8f480d86cdc11341372746",
      "name": "Treasury Operations",
      "purpose": "TREASURY",
      "isolation_policy": "MPC",
      "status": "ACTIVE",
      "version": 1,
      "created_by": "d2f46f7e234c40a4a54e54208368d8d5",
      "created_at": "2026-08-12T21:00:00Z",
      "updated_at": "2026-08-12T21:00:00Z",
      "membership_id": "7bb755ad325c48e5a4f4cc7f5711fa62",
      "role": "OWNER",
      "membership_version": 1,
      "idempotent_replay": false,
      "preference_version": null
    }
  ],
  "next_cursor": null
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then read one workspace for its current policy and role.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the workspace, active roster, invitation, membership and preference versions, role, tenant binding, and idempotent mutation receipt.

400The JSON body or required signed headers are malformed.Request must change · JSON RESPONSE+

{
  "code": "invalid_json",
  "message": "The JSON body or required signed headers are malformed."
}

INTEGRATION DECISIONinvalid_json

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. A corrected read may be sent as a new attempt.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the workspace, active roster, invitation, membership and preference versions, role, tenant binding, and idempotent mutation receipt.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

401The bearer credential or HTTP Message Signature is missing, expired, replayed, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential or HTTP Message Signature is missing, expired, replayed, or invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for tenant-bound workspaces, memberships, invitations, roles, preferences, revisions, and lifecycle receipts.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

403The principal lacks the required scope, workspace role, or tenant authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "workspace_forbidden",
  "message": "The principal lacks the required scope, workspace role, or tenant authority."
}

INTEGRATION DECISIONworkspace_forbidden

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for tenant-bound workspaces, memberships, invitations, roles, preferences, revisions, and lifecycle receipts.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

503The authoritative Identity workspace service is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_security_unavailable",
  "message": "The authoritative Identity workspace service is unavailable."
}

INTEGRATION DECISIONidentity_security_unavailable

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh the workspace, active roster, invitation, membership and preference versions, role, tenant binding, and idempotent mutation receipt.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

OPERATIONAL NOTES

Security and lifecycle guarantees

The tenant boundary is derived from the authenticated Identity subject; callers cannot enumerate another user's workspaces.
Responses carry Cache-Control: no-store and Pragma: no-cache.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

GET/api/v1/workspaces/allWORKSPACE: Get Available Workspaces

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗