RevKeenDocs
StatusSupport
API Reference
👥 Customers & VaultEntitlements

List entitlements

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

GET/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 /entitlements/check — Check entitlement access

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 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.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

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)

Range1 <= value <= 100
Default50
offset?|

Results to skip

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X GET "https://api.revkeen.com/v2/entitlements?customer_id=11111111-1111-4111-8111-111111111111&include_expired=false&benefit_type=example&category=example" \
  -H "x-api-key: $REVKEEN_API_KEY"

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": [    {      "id": "0f1a2b3c-4d5e-4663-8a71-8c9d0e1f2a34",      "customer_id": "c2a1e7d4-5b3f-4a8e-9d21-6f0b3e4c7a11",      "benefit_id": "9e0f1a2b-3c4d-4652-af60-7b8c9d0e1f23",      "benefit": {        "id": "9e0f1a2b-3c4d-4652-af60-7b8c9d0e1f23",        "name": "Priority support",        "description": "Replies within four working hours.",        "benefit_type": "custom",        "benefit_key": "priority_support",        "category": "support",        "icon_url": null,        "display_order": "1",        "is_active": true,        "default_value": null,        "config": null      },      "granted_at": "2026-04-02T10:05:00.000Z",      "expires_at": null,      "metadata": {},      "status": "active",      "has_access": true,      "access_level": "full",      "subscription_id": "d4e6f8a1-2b3c-4d5e-9f60-7a8b9c0d1e24",      "subscription_status": "active"    }  ],  "pagination": {    "limit": 50,    "offset": 0,    "total": 1  },  "customer": {    "id": "c2a1e7d4-5b3f-4a8e-9d21-6f0b3e4c7a11",    "email": "ada.lovelace@example.com",    "name": "Ada Lovelace"  }}