---
title: "Get a list of addons"
method: GET
path: "/api/v1/addons"
tags: ["Addons"]
---

# Get a list of addons

`GET /api/v1/addons`

Retrieves a paginated list of addons in the environment.

## Query parameters

- `after` string, uuid
- `before` string, uuid
- `limit` integer
- `productId` string
- `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 addon objects.

- AddonListResponseDto — Response list object
  - `data` object[], required
    - `id` string, required — The unique identifier for the entity
    - `displayName` string, required — The display name of the package
    - `description` string, nullable, required — The description of the package
    - `productId` string, required — The product id of the package
    - `status` 'DRAFT' | 'PUBLISHED' | 'ARCHIVED', required — The status of the package
    - `pricingType` 'FREE' | 'PAID' | 'CUSTOM', nullable, required — The pricing type of the package
    - `billingId` string, nullable, required — The unique identifier for the entity in the billing provider
    - `versionNumber` integer, required — The version number of the package
    - `isLatest` boolean, nullable, required — Indicates if the package is the latest version
    - `entitlements` object[], required — List of entitlements of the package
      - `type` 'FEATURE' | 'CREDIT', required
      - `id` string, required — The unique identifier for the entity
    - `metadata` object, required — Metadata associated with the entity
    - `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
    - `maxQuantity` integer, nullable, required — The maximum quantity of this addon that can be added to a subscription
    - `dependencies` string[], nullable, required — List of addons the addon is dependant on
  - `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)