---
title: "Get a list of custom currencys"
method: GET
path: "/api/v1/credits/custom-currencies"
tags: ["Custom currencies"]
---

# Get a list of custom currencys

`GET /api/v1/credits/custom-currencies`

Retrieves a paginated list of custom currencies in the environment. Archived currencies are excluded by default; pass `status=ARCHIVED` (or `status=ACTIVE,ARCHIVED`) to include them.

## Query parameters

- `after` string, uuid
- `before` string, uuid
- `limit` integer
- `status` string[]

## Headers

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

## Response `200`

A paginated list of custom currency objects.

- CustomCurrencyListResponseDto — Response list object
  - `data` object[], required
    - `id` string, required — The unique identifier for the custom currency
    - `displayName` string, required — The display name of the custom currency
    - `symbol` string, nullable, required — The symbol used to represent the custom currency
    - `description` string, nullable, required — Description of the currency
    - `units` object, nullable, required — Singular and plural unit labels for a custom currency
      - `singular` string, nullable, required — Singular form of the unit label
      - `plural` string, nullable, required — Plural form of the unit label
    - `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
    - `archivedAt` string, date-time, nullable, required — Timestamp of when the record was deleted
  - `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)