GET

Workspace Management

Get workspace details

/api/v2/workspaces/{workspace_id}

AUTHENTICATIONBearer token · workspaces:readService owneridentity-service · identity-workspaceContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

Read one workspace’s current operating policy together with the caller’s membership and role.

When to use it

Call this after choosing a workspace and before presenting workspace-scoped controls, inviting members, changing roles, or opening wallet and merchant workflows.

OUTCOME · Inspect

What changes

Read-only. It confirms current membership and workspace configuration without selecting or modifying the workspace.

WHY IT MATTERS

Provides the minimum authoritative context needed to explain what the workspace is for and what the caller can do there.
Keeps private roster and invitation data out of a general workspace detail read.

ISOLATION + AUTHORITY

Only an active member can read this object. The response describes this workspace and the caller’s relationship to it; it does not expose other members’ private Identity or wallet data.

BEFORE YOU CALL

A bearer token with workspaces:read.
An active membership in the requested workspace.

WHAT TO DO NEXT

List members when roster information is required.
Select the workspace when subsequent account or wallet views should use this operating boundary.

AGENT GUIDANCE

Re-read this projection before a consequential workspace mutation instead of trusting a cached role or status.
Do not infer the full roster or pending invitations from this response; those are deliberately separate capabilities.
If the membership is no longer active, stop all dependent workspace and wallet work.

Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

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_…

workspace_idpathRequired

32-character workspace identifierAccessible workspace owned by Identity.EXAMPLEb00dc220da8f480d86cdc11341372746

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

200Workspace and the caller's current membership projection.Read completed · JSON RESPONSE+

{
  "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
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then list members when roster information is required.
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.

404The workspace, invitation, or membership was not found in the caller's authority boundary.Resource not visible · JSON RESPONSE+

{
  "code": "workspace_not_found",
  "message": "The workspace, invitation, or membership was not found in the caller's authority boundary."
}

INTEGRATION DECISIONworkspace_not_found

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
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.

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

Only an active member can read the workspace.
Private membership and invitation data is not embedded in this projection.

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/detailsWORKSPACE: Get Workspace Details

Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory