---
title: "Get add-on collection"
method: GET
path: "/add-ons"
tags: ["Add-Ons"]
---

# Get add-on collection

`GET /add-ons`

Query all add-ons filtered by provided parameters

## Query parameters

- `id` integer
- `name` string
- `description` string
- `amount` number, float
- `frequency` 'one_time' | 'recurring'
- `isQuantityEditable` 'false' | 'true'
- `sortBy` 'asc' | 'desc'
- `limit` integer
- `offset` integer

## Headers

- `api-token` string, required

## Response `200`

Successful add-on collection query. The response body contains the data representation of all queried  add-ons matching the provided parameters.

- AddOnCollectionRes
  - `data` BaseAddOn[]
    - `id` integer
    - `dateCreated` string, date-time
    - `dateUpdated` string, date-time
    - `name` string
    - `description` string
    - `amount` number, float
    - `frequency` string
    - `isQuantityEditable` string

## Other responses

- `204` — No add-ons found matching the provided parameters.
- `400` — You are initiating a request with invalid parameter and/or body values.
- `401` — You are not authorized to access this resource. Please ensure that you are authenticated, and that you are using the `api-token` header
- `403` — You do not have permission to access this resource. Please ensure you are both authenticated and that you have the required roles/permissions active.
- `500` — Helcim internal server error encountered.

---

[API](https://skmtc.net/helcim/apis/the-helcim-api.md) · [All operations](https://skmtc.net/helcim/apis/the-helcim-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helcim/the-helcim-api/versions/345052ca6578/schema)