---
title: "Get a list of addon entitlements"
method: GET
path: "/api/v1/addons/{addonId}/entitlements"
tags: ["Addon Entitlements"]
---

# Get a list of addon entitlements

`GET /api/v1/addons/{addonId}/entitlements`

Retrieves a list of entitlements for an addon.

## Path parameters

- `addonId` string, required

## Headers

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

## Response `200`

A list of addon entitlement objects.

- AddonPackageEntitlementListResponseDto — Response list object
  - `data` union[], required
    - union
      - object — Feature entitlement response
        - `id` string, required — Unique identifier of the entitlement
        - `description` string, nullable, required — Optional description of the entitlement
        - `isGranted` boolean, required — Whether the entitlement is granted
        - `isCustom` boolean, nullable, required — Whether this is a custom entitlement
        - `order` number, nullable, required — Display order of the entitlement
        - `behavior` 'Increment' | 'Override', required — Entitlement behavior (Increment or Override)
        - `hiddenFromWidgets` string[], required — Widget types where this entitlement is hidden
        - `displayNameOverride` string, nullable, required — Override display name for the entitlement
        - `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
        - `type` 'FEATURE', required — Entitlement type (FEATURE or CREDIT)
        - `usageLimit` number, nullable, required — Usage limit (for feature entitlements)
        - `hasUnlimitedUsage` boolean, nullable, required — Whether usage is unlimited (for feature entitlements)
        - `hasSoftLimit` boolean, nullable, required — Whether the usage limit is a soft limit (for feature entitlements)
        - `resetPeriod` 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR', nullable, required — Usage reset period (for feature entitlements)
        - `resetPeriodConfiguration` union, required — Reset period configuration (for feature entitlements)
          - 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)
        - `enumValues` string[], nullable, required — Allowed enum values (for feature entitlements)
      - object — Credit entitlement response
        - `id` string, required — Unique identifier of the entitlement
        - `description` string, nullable, required — Optional description of the entitlement
        - `isGranted` boolean, required — Whether the entitlement is granted
        - `isCustom` boolean, nullable, required — Whether this is a custom entitlement
        - `order` number, nullable, required — Display order of the entitlement
        - `behavior` 'Increment' | 'Override', required — Entitlement behavior (Increment or Override)
        - `hiddenFromWidgets` string[], required — Widget types where this entitlement is hidden
        - `displayNameOverride` string, nullable, required — Override display name for the entitlement
        - `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
        - `type` 'CREDIT', required — Entitlement type (FEATURE or CREDIT)
        - `amount` number, nullable, required — Credit amount (for credit entitlements)
        - `cadence` 'MONTH' | 'YEAR', nullable, required — Credit grant cadence (for credit entitlements)
        - `hasSoftLimit` boolean, nullable, required — Whether the credit wallet is soft-limited. When true, getEntitlement returns hasAccess=true past the limit; vendors decide whether to enforce. Defaults to false.
        - `dependencyFeatureId` string, nullable — The feature ID this entitlement depends on (for credit entitlements). The entitlement value will be calculated as: base amount × dependency feature usage limit
  - `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/versions/ffc977f1c07e/schema)