Skip to main content
GET
/
entitlements
Retrieve customer entitlements
curl --request GET \
  --url https://api.kelviq.com/api/v1/entitlements/ \
  --header 'Authorization: Bearer <token>'
{
  "customerId": "cust_456",
  "entitlements": [
    {
      "featureId": "advanced-analytics",
      "featureType": "METER",
      "hasAccess": true,
      "resetAt": "2025-05-22 08:27:45",
      "hardLimit": false,
      "usageLimit": 3,
      "currentUsage": 0,
      "remaining": 3
    }
  ]
}

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

​
customerId
string
required

The unique identifier for the customer.

​
featureId
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[]