---
title: "Get Currencies"
method: GET
path: "/v4/currencies"
tags: ["Reference Data"]
---

# Get Currencies

`GET /v4/currencies`

Retrieves a list of currencies available on the system along with their relevant details.
<br />With this endpoint, you can search for specific currencies, paginate results, and sort the data as needed.

## Query parameters

- `searchTerm` string
- `pageSize` integer
- `pageNumber` integer
- `sortBy` 'CurrencyName' | 'CurrencyCode' — Sort By
- `sortDir` 'Ascending' | 'Descending' — Order Direction

## Response `200`

Returns a list of currencies.

- CurrenciesPagedResponse — The paged response containing the entities for the requested page only, and the total number available.
  - `Currencies` Currency[], required — An array containing the individual currency records retrieved by the API. <br />Each record includes detailed information about a specific currency.
    - `CurrencyName` string, required — The official name of the currency. <br />This field is important for identifying currencies within the response and can help users understand the currency's usage.
    - `CurrencyCode` string, required — A three-letter code (ISO 4217) assigned to each currency, which uniquely identifies it in international standards. <br />This code is commonly used in financial transactions and currency exchanges.
  - `TotalCount` integer, required — An integer representing the total number of currencies matching the search criteria, regardless of pagination. <br />This information is useful for understanding the full scope of available results.

## Other responses

- `400` — Invalid request response.
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)