Sign in
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

Changes

Changed in 2 of the 10 revisions of this API.222

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextToken to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b512See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property nextToken from the response with the 200 status

      response-optional-property-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog