RevKeen Docs
Api reference

List entitlements

Retrieve all entitlements for a customer. Pass customer_id as a query parameter. Includes computed access status based on subscription state.

Related endpoints

  • GET /customers/{customerId}/entitlements — List customer entitlements
  • POST /customers/{customerId}/entitlements — Grant entitlement to customer
  • DELETE /customers/{customerId}/entitlements — Revoke entitlement by benefit key
  • GET /customers/{customerId}/entitlements/check — Check customer entitlement
  • DELETE /customers/{customerId}/entitlements/{entitlementId} — Revoke entitlement by ID
  • GET /entitlements/check — Check entitlement access

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/entitlements

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Query Parameters

customer_id*string

Customer UUID (required)

Formatuuid
include_expired?|

Include expired entitlements

Defaultfalse
benefit_type?string

Filter by benefit type

category?string

Filter by category

limit?integer

Maximum results (1-100)

Default50
Range1 <= value <= 100
offset?|

Results to skip

Default0
Range0 <= value

Response Body

application/json

curl "https://api.revkeen.com/v2/entitlements?customer_id=value" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
      "benefitId": "551f0400-d5b0-411f-b487-14e33a04c610",
      "benefit": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "description": "string",
        "benefitType": "string",
        "benefitKey": "string",
        "category": "string",
        "iconUrl": "string",
        "displayOrder": "string",
        "isActive": true,
        "defaultValue": null,
        "config": null
      },
      "grantedAt": "2019-08-24T14:15:22Z",
      "expiresAt": "2019-08-24T14:15:22Z",
      "metadata": {},
      "status": "active",
      "hasAccess": true,
      "accessLevel": "full",
      "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
      "subscriptionStatus": "string"
    }
  ],
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "email": "string",
    "name": "string"
  }
}
Empty
Empty
Empty
Edit on GitHub