---
title: "List entitlements"
method: GET
path: "/entitlements"
---

# List entitlements

`GET /entitlements`

## Request

- Base URL: `https://api.sandbox.cleeng.com/3.1`
- URL: `https://api.sandbox.cleeng.com/3.1/entitlements`
- Auth: API key in header `X-Publisher-Token`

You can use this endpoint to list a customer's entitlements and calculate a subscription's length. You can fetch entitlements for two types of offer: **subscriptions** and **passes** only. (For more information on offers, see [What is a Cleeng offer?](https://publisher.support.cleeng.com/hc/en-us/articles/360012552919-What-is-a-Cleeng-offer-)). <br><br> If there are two or more subscriptions or passes for the same offer and the same customer, there will be as many entitlements returned as there are subscriptions / passes.

## Query parameters

- `customerId` integer, required
- `customerEmail` string
- `offset` integer, required
- `limit` integer, required
- `status` string
- `offerType` string

## Response `200`

200

- object
  - `success` boolean
  - `data` object[]
    - `offerType` string
    - `offerId` string
    - `customerId` integer
    - `status` string
    - `expiresAt` integer
    - `startedAt` integer
  - `nextPage` boolean
  - `message` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/cleeng/apis/api-31.md) - [All operations](https://skmtc.dev/cleeng/apis/api-31/llms.txt) - [OpenAPI document](https://skmtc.dev/cleeng/apis/api-31/revisions/df55396cda4f?raw)