Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Query Parameters

resourceId
string

Resource ID to scope entitlements to a specific resource

Maximum string length: 255

Response

The entitlements state including feature and credit entitlements, and an optional access denied reason.

Response object

data
CustomerEntitlementsState · object
required

The effective entitlements state for a customer or resource.