DOCUMENTATIONv2

GET

Teams & workspaces

List members

/api/v2/workspaces/{workspace_id}/members

AUTHENTICATIONBearer token · workspaces:readAUTHORITATIVE OWNERidentity-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

List the active, privacy-minimized membership roster that governs collaboration inside one workspace.

WHEN THIS CALL IS USEFUL

Call this to render a member directory, choose a membership for role administration, or verify who can participate before configuring shared workspace policy.

OUTCOME · Inspect membership

What changes

Read-only. It returns active membership identifiers, roles, versions, and lifecycle timestamps.

WHY IT MATTERS

Supports transparent team administration without turning the endpoint into a global Identity directory.
Provides the version needed for safe, optimistic role changes.

ISOLATION + AUTHORITY

The roster is visible only inside an accessible workspace and omits emails, invitation recipients, invitation tokens, and internal Identity subject identifiers.

BEFORE YOU CALL

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

WHAT TO DO NEXT

Change an eligible member’s role with the current membership version.
Revoke an eligible membership or invite a missing collaborator.

AGENT GUIDANCE

Use membership_id—not a profile or email—as the target of role and revocation calls.
Read the current version immediately before changing a role; after a 409, re-read rather than overwriting concurrent administration.
A workspace role controls workspace administration but does not by itself grant MPC signing, wallet spending, publisher, matching, or trading authority.

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

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

200Active, privacy-minimized membership roster for the accessible workspace.Read completed · JSON RESPONSE+

{
  "workspace_id": "b00dc220da8f480d86cdc11341372746",
  "items": [
    {
      "membership_id": "7bb755ad325c48e5a4f4cc7f5711fa62",
      "profile_uuid": "f8317aef81764e1f923037c1b76df8de",
      "role": "MEMBER",
      "status": "ACTIVE",
      "version": 2,
      "joined_at": "2026-08-13T21:00:00Z",
      "updated_at": "2026-08-14T08:15:00Z"
    }
  ],
  "next_cursor": null
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then change an eligible member’s role with the current membership version.
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

The roster is available only to an active workspace member and is not a global Identity directory.
Items omit internal Identity subject identifiers, email addresses, invitation recipients, and invitation tokens. Use profile_uuid only with a separately authorized profile capability.
Read membership_id and version immediately before a role change; re-read after 409 instead of overwriting concurrent state.

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 ↗