GET

Tenant and brand management

List entitlements

/api/v2/admin/tenants/{tenant_uuid}/entitlements
AUTHENTICATIONBearer token · admin:tenants:readService ownertenant-configuration-serviceContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

List tenant product and feature entitlements with source and expiry.

When to use it

Use to inspect effective tenant product availability and domain-owned policy before presenting or authorizing a product workflow.

OUTCOME · Discover

What changes

Read-only product-policy projection. It grants no bearer scope, role, credential, billing settlement, infrastructure, or trading permission.

WHY IT MATTERS

  • Gives people and agents a contract-backed way to discover entitlements.
  • Separates draft configuration work from effective tenant behavior so changes can be reviewed, audited, published atomically, and reverted through a new draft.

ISOLATION + AUTHORITY

Platform administrator, tenant, domain, certificate, brand, navigation, feature declaration, entitlement source, configuration revision, review, publication, and application-domain authority remain distinct. A tenant configuration or entitlement cannot enable frozen trading controls, matching, prediction execution, ingress, publisher activity, market status, traffic, wallet signing, or settlement authority.

BEFORE YOU CALL

  • Authenticate at the documented boundary: bearer+scope.
  • Supply the required tenant_uuid (path) exactly as defined by the live contract.
  • Resolve the tenant UUID, current published configuration version, complete desired configuration, administrator authority, and any domain-owned policy that cannot be granted by tenant settings.

WHAT TO DO NEXT

  • Use the returned tenant and revision identifiers to inspect the exact effective or candidate configuration relevant to the task.
  • Refresh tenant detail after any publication or reversion and resolve domain-owned authorization separately from displayed entitlements.

AGENT GUIDANCE

  • Use entitlements only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Supply the required tenant_uuid (path) exactly as defined by the live contract.
  • Distinguish tenant creation, draft revision, validation, review, publication, supersession, reversion draft, domain verification, certificate readiness, entitlement visibility, and domain-owned authorization.
  • Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.
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 admin:tenants:read authority.EXAMPLEBearer hc_live_…

tenant_uuidpathRequired

identifierStable tenant uuid selecting the exact resource addressed by this route.EXAMPLEtenant-uuid-01

X-Request-IDheaderOptional

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

RESPONSES

Status and payload examples

200Effective product-entitlement projection for the currently published configuration; entitlements are not bearer scopes or trading permissions.Read completed · JSON RESPONSE+
{
  "configuration_version": 0,
  "items": [
    "example-item"
  ],
  "tenant_uuid": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB"
}
INTEGRATION DECISION
CALLER ACTION
Accept the returned representation or receipt, then use the returned tenant and revision identifiers to inspect the exact effective or candidate configuration relevant to the task.
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 tenant and brand revisions, domain verification, entitlement and administrator state, and any dependent workspace or application bindings.
401The administrator bearer is missing or invalid.Authentication required · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid 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 identity, brand, domain, configuration, entitlement, administrator, and lifecycle projections.
ESCALATE WHEN
Escalate when tenant identity, domain ownership, brand version, entitlement, or last-administrator safety cannot be proven.
403The bearer lacks admin:tenants:read.Authority or policy denied · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
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 identity, brand, domain, configuration, entitlement, administrator, and lifecycle projections.
ESCALATE WHEN
Escalate when tenant identity, domain ownership, brand version, entitlement, or last-administrator safety cannot be proven.
404The tenant does not exist.Resource not visible · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
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 tenant and brand revisions, domain verification, entitlement and administrator state, and any dependent workspace or application bindings.
ESCALATE WHEN
Escalate when tenant identity, domain ownership, brand version, entitlement, or last-administrator safety cannot be proven.
422The tenant identifier is malformed.Request must change · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
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 tenant and brand revisions, domain verification, entitlement and administrator state, and any dependent workspace or application bindings.
ESCALATE WHEN
Escalate when tenant identity, domain ownership, brand version, entitlement, or last-administrator safety cannot be proven.
503The authoritative tenant control plane is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
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 tenant and brand revisions, domain verification, entitlement and administrator state, and any dependent workspace or application bindings.
ESCALATE WHEN
Escalate when tenant identity, domain ownership, brand version, entitlement, or last-administrator safety cannot be proven.

OPERATIONAL NOTES

Security and lifecycle guarantees

  • Returns stable entitlement identifiers, capability codes, ENABLED/DISABLED state, policy versions, effective windows, and non-secret policy. Entitlement changes are made only through complete configuration revisions and do not by themselves grant credentials or authority in another domain.
  • 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.
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