---
title: "Pages what the customer may reach."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo customer API › entitlement

`GET /v1/stores/{store}/entitlements`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `read`

## Path parameters

- `store` (`listEntitlements.path.store`; string, required) — A hostname of the store.

## Query parameters

- `filter` (`listEntitlements.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listEntitlements.query.sort`; string, optional)
  - one of `"product"`, `"title"`
- `direction` (`listEntitlements.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listEntitlements.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listEntitlements.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listEntitlements.query.count`; boolean, optional)

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/customer/v1/stores/<store>/entitlements' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/customer/v1/stores/<store>/entitlements';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/customer/v1/stores/<store>/entitlements"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Pages what the customer may reach.

#### Example

```json
{
  "items": [
    {
      "product_id": "string",
      "tier_rank": 0,
      "tier_expires_at": "string",
      "expires_at": "string",
      "held": true,
      "order": {
        "id": "string",
        "number": 0
      },
      "renews_at": "string",
      "given_by": {
        "name": "string"
      },
      "attending": true,
      "ticket": {
        "status": "string",
        "cancel_reason": "string",
        "tier": {
          "id": "string",
          "name": "string",
          "rank": 0
        }
      }
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listEntitlements.response.200.items`; array<object>, required)
  - `product_id` (`listEntitlements.response.200.items.product_id`; string, required)
  - `tier_rank` (`listEntitlements.response.200.items.tier_rank`; number, required)
  - `tier_expires_at` (`listEntitlements.response.200.items.tier_expires_at`; any of, required)
    - any of: `string`, `null`
  - `expires_at` (`listEntitlements.response.200.items.expires_at`; any of, required)
    - any of: `string`, `null`
  - `held` (`listEntitlements.response.200.items.held`; boolean, required)
  - `order` (`listEntitlements.response.200.items.order`; any of, required) — The caller's order behind the highest standing grant that came from one; null when none did, as with a grant by hand.
    - any of: `object`, `null`
  - `renews_at` (`listEntitlements.response.200.items.renews_at`; any of, required) — When a subscription of the product next renews; null when none will.
    - any of: `string`, `null`
  - `given_by` (`listEntitlements.response.200.items.given_by`; any of, required) — For an event ticket someone else bought the caller as their guest: who; null otherwise.
    - any of: `object`, `null`
  - `attending` (`listEntitlements.response.200.items.attending`; boolean, required) — Whether the caller is going to the event, a ticket with no tier included; false for any other product.
  - `ticket` (`listEntitlements.response.200.items.ticket`; any of, required) — The caller's ticket to the event as its grants read now: whether it lets them in, why not, and its type; null for any other product, and for a moment after a first ticket while it is listed, even with `attending` already true.
    - any of: `object`, `null`
- `cursor` (`listEntitlements.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listEntitlements.response.200.total`; number, optional)
- `facets` (`listEntitlements.response.200.facets`; map<map<number>>, optional)

### default

A problem; see https://api.sherpo.io/customer/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`listEntitlements.response.default.type`; string, required)
  - format `uri`
- `title` (`listEntitlements.response.default.title`; string, required)
- `status` (`listEntitlements.response.default.status`; integer, required)
- `detail` (`listEntitlements.response.default.detail`; string, required)
- `code` (`listEntitlements.response.default.code`; string, optional)
- `context` (`listEntitlements.response.default.context`; object, optional)
- `reached_core` (`listEntitlements.response.default.reached_core`; boolean, optional)
- `core_answer` (`listEntitlements.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/customer-api/reference/list-entitlements/index.md
