Skip to main content
GET
Retrieve customer entitlements
Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Query Parameters

customer_id
string
required

The unique identifier for the customer.

feature_id
string

Optional. The unique identifier for a specific feature. If provided, filters entitlements to this feature.

Response

200 - application/json

A list of entitlement details for the customer.

customerId
string
Example:

"cust_456"

entitlements
object[]