Get all currencies
Get a list of currencies accepted in the CareCloud platform.
Currencies represent the ISO currency codes configured for use in a project. They are used to denominate credit amounts and purchase values. Each project has one default currency; others can be specified explicitly when depositing or reducing credits.
Use this endpoint to retrieve valid currency IDs for use in credit operations. Filter by currency_name or currency_code to locate a specific currency.
Related: POST /credits/actions/deposit (enterprise interface only), POST /credits/actions/reduce (enterprise interface only)
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
Name or part of the name of the currency you looking for.
The unique code of a currency represented by ISO code.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"currencies": [
{
"currency_id": "86e05affc7a7abefcd513ab400",
"name": "CZK",
"code": "CZK"
}
],
"total_items": 1
}
}