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

# List

`GET /entitlements/`

## Request

- Base URL: `https://restapi.ordergroove.com`
- URL: `https://restapi.ordergroove.com/entitlements/`
- Auth: one of:
  - none
  - API key in header `x-api-key`

List entitlements associated to merchant's customers. Only relevant for merchants offering digital products.

## Query parameters

- `merchant` string, required
- `merchant_user_id` string
- `resource_public_id` string
- `resource_public_ids` string
- `external_resource_id` string
- `live` boolean
- `resource_name` string
- `grantee_external_ids_exact` string

## Response `200`

200

- object
  - `next` string: URL to get the next page of results. `null` if there are no more pages.
  - `previous` string: URL to get the previous page of results. `null` if there are no previous pages.
  - `results` object[]: *Note:* This endpoint returns up to 100 entitlements per request by default, which differs from other endpoints in this API.
    - `merchant` string
    - `public_id` string
    - `merchant_user_id` string
    - `initial_activation_date` string
    - `latest_activation_date` string
    - `grace_period` integer
    - `live` boolean
    - `access_type` string
    - `expiration` string
    - `created` string
    - `last_updated` string
    - `resource` object
      - `public_id` string
      - `merchant` string
      - `name` string
      - `external_resource_id` string
      - `description` string
      - `image_url` string
      - `created` string
      - `last_updated` string
    - `grantees` object[]

## Other responses

- `403`: 403

---

[API](https://skmtc.dev/ordergroove/apis/ordergroove-restrpc.md) - [All operations](https://skmtc.dev/ordergroove/apis/ordergroove-restrpc/llms.txt) - [OpenAPI document](https://skmtc.dev/ordergroove/apis/ordergroove-restrpc/revisions/ba97e740d08c?raw)