DOCUMENTATIONv2

GET

Teams & workspaces

List invitations

/api/v2/workspaces/{workspace_id}/invitations

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

PURPOSE + BUSINESS CONTEXT

List recipient and delivery lifecycle state for workspace invitations without revealing one-time tokens.

WHEN THIS CALL IS USEFUL

Call this when a tenant member, team administrator, account client, or workspace-aware agent needs to discover invitations and choose a canonical record for a later step so it can create and select isolated workspaces and govern invitations, memberships, roles, and active execution context.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover invitations.
Keeps teams, resources, policies, credentials, wallets, and activity partitioned by workspace while allowing one identity to participate in multiple bounded environments.

ISOLATION + AUTHORITY

Tenant, identity, workspace, invitation, membership, role, active-workspace selection, resource ownership, wallet, policy, and entitlement boundaries remain distinct. Membership or selection does not grant tenant administration, wallet signing, payment, settlement, publisher, matching, or trading authority beyond separately evaluated scopes and policy.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required workspace_id (path) exactly as defined by the live contract.
Resolve the tenant, authenticated identity, target workspace, current membership and role version, invitation state, and last-owner safeguards.

WHAT TO DO NEXT

Select the canonical workspace or membership identifier and confirm the caller's active membership, role, and tenant boundary.
Resolve permissions again in the owning wallet, resource, or business domain before offering a dependent action.

AGENT GUIDANCE

Use invitations only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required workspace_id (path) exactly as defined by the live contract.
Treat workspace creation, invitation, acceptance, active membership, role assignment, active-context selection, revocation, and dependent-resource access as separate state transitions.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

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 workspaces:read authority.EXAMPLEBearer hc_live_…

workspace_idpathRequired

identifierStable workspace id selecting the exact resource addressed by this route.EXAMPLEworkspace-id-01

X-Request-IDheaderOptional

stringOptional caller correlation identifier. The gateway emits the effective value on the response.

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

200Canonical resource projection.Read completed · JSON RESPONSE+

{
  "items": [
    {
      "accepted_at": "2026-09-02T18:30:00Z",
      "attempts": 0,
      "created_at": "2026-09-02T18:30:00Z",
      "delivered_at": "2026-09-02T18:30:00Z",
      "delivery_status": "example-delivery-status",
      "email": "[email protected]",
      "expires_at": "2026-09-02T18:30:00Z",
      "invitation_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
      "last_attempt_at": "2026-09-02T18:30:00Z",
      "last_error": "example-last-error",
      "role": "MEMBER",
      "status": "ACTIVE"
    }
  ],
  "next_cursor": "example-next-cursor",
  "workspace_id": "a7c13c85b4ad44f8a2b8c665f34c9910"
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then select the canonical workspace or membership identifier and confirm the caller's active membership, role, and tenant boundary.
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.

401Bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer or proof-of-possession credential is 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, role, tenant, or step-up authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "step_up_required",
  "message": "The caller lacks role authority or fresh purpose-bound approval."
}

INTEGRATION DECISIONstep_up_required

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 requested resource does not exist within the authenticated authority boundary.Resource not visible · JSON RESPONSE+

{
  "code": "workspace_resource_not_found",
  "message": "The requested workspace, membership, or invitation was not found."
}

INTEGRATION DECISIONworkspace_resource_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 service or read model is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_security_unavailable",
  "message": "The authoritative Identity security service is temporarily 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

Returns recipient, lifecycle, and delivery status to an authorized workspace administrator without revealing one-time invitation tokens.
The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.

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 ↗