---
title: "Get a list of promotional entitlements"
method: GET
path: "/api/v1/customers/{id}/promotional-entitlements"
tags: ["Promotional Entitlements"]
---

# Get a list of promotional entitlements

`GET /api/v1/customers/{id}/promotional-entitlements`

Retrieves a paginated list of a customer's promotional entitlements.

## Path parameters

- `id` string, required

## Query parameters

- `after` string, uuid
- `before` string, uuid
- `limit` integer
- `status` string[]
- `createdAt` object
  - `gt` string, date-time — Greater than the specified createdAt value
  - `gte` string, date-time — Greater than or equal to the specified createdAt value
  - `lt` string, date-time — Less than the specified createdAt value
  - `lte` string, date-time — Less than or equal to the specified createdAt value

## Headers

- `X-ACCOUNT-ID` string
- `X-ENVIRONMENT-ID` string

## Response `200`

A paginated list of promotional entitlement objects.

- PromotionalEntitlementListResponseDto — Response list object
  - `data` object[], required
    - `id` string, uuid, required — Unique identifier for the entity
    - `description` string, nullable, required — The description of the entitlement
    - `featureId` string, uuid, required — The unique identifier of the entitlement feature
    - `createdAt` string, date-time, required — Timestamp of when the record was created
    - `updatedAt` string, date-time, required — Timestamp of when the record was last updated
    - `startDate` string, date-time, required — The start date of the entitlement
    - `endDate` string, date-time, nullable, required — The end date of the promotional entitlement
    - `isVisible` boolean, required — Whether the entitlement is visible
    - `usageLimit` number, nullable, required — The usage limit of the entitlement
    - `hasSoftLimit` boolean, nullable, required — Whether the entitlement has a soft limit
    - `hasUnlimitedUsage` boolean, nullable, required — Whether the entitlement has an unlimited usage
    - `status` 'Active' | 'Expired' | 'Paused', required — The status of the entitlement
    - `period` '1 week' | '1 month' | '6 month' | '1 year' | 'lifetime' | 'custom', required — The grant period of the promotional entitlement
    - `resetPeriod` 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR', nullable, required — The reset period of the entitlement
    - `resetPeriodConfiguration` union, required — The reset period configuration of the entitlement
      - object — Yearly reset configuration
        - `accordingTo` 'SubscriptionStart', required — Reset anchor (SubscriptionStart)
      - object — Monthly reset configuration
        - `accordingTo` 'SubscriptionStart' | 'StartOfTheMonth', required — Reset anchor (SubscriptionStart or StartOfTheMonth)
      - object — Weekly reset configuration
        - `accordingTo` 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday', required — Reset anchor (SubscriptionStart or specific day)
    - `environmentId` string, uuid, required — The unique identifier for the environment
    - `enumValues` string[], nullable, required — The enum values of the entitlement
    - `featureGroupIds` string[], nullable, required — Feature group IDs associated with this entitlement
  - `pagination` object, required — Pagination metadata including cursors for navigating through results
    - `next` string, uuid, nullable, required — Cursor for fetching the next page of results, or null if no additional pages exist
    - `prev` string, uuid, nullable, required — Cursor for fetching the previous page of results, or null if at the beginning

## Other responses

- `400` — bad request.
- `401` — User is not authenticated.
- `403` — User is not allowed to access this resource.
- `429` — Too many requests.

---

[API](https://skmtc.net/stiggio/apis/stigg-api.md) · [All operations](https://skmtc.net/stiggio/apis/stigg-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stiggio/stigg-api/revisions/3e2c8cfcd035/schema)