v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Currency

List Currencies

Retrieve a list of Currencies.

Retrieves a list of Currencies for the specified Organization. This endpoint supports pagination and includes various query parameters to filter the Currencies based on Currency ID, and short codes.

get/organizations/{orgId}/picklists/currency

Path parameters

orgIdstring required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

Specifies the maximum number of Currencies to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of Currencies in a paginated list.

idsstring[]

An optional parameter to filter the list based on specific Currency unique identifiers (UUIDs).

codesstring[]

An optional parameter to retrieve specific Currencies based on their short codes.

archivedboolean

Filter by archived flag. A True / False flag indicating whether to return Currencies that are archived (obsolete).

  • TRUE - return archived Currencies.
  • FALSE - archived Currencies are not returned.

Response

Returns the list of Currencies

nextTokenstring