List currencies

Reference catalogue of currencies. Public endpoint — does not require authentication or workspace headers.

GET /generals/currencies

List currencies

cURL

curl --request GET \
  --url https://api.piriod.com/generals/currencies/

200

{
  "count": 142,
  "results": [
    {
      "id": "CLP",
      "name": "<string>",
      "name_en": "<string>",
      "country": "<string>",
      "default": true,
      "is_chargeable": true,
      "available": true,
      "rounded": true
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Query Parameters

page · integer · default: 1

Page number to retrieve (1-indexed).

Required range: x >= 1

page_size · integer · default: 20

Number of items per page.

Required range: 1 <= x <= 100

country · string

name · string

Response

200 - application/json

Paginated currency list.

count · integer · required

Total number of items matching the filter.

Example:

142

results · object[] · required

The items in the current page.

Show child attributes

next · string<uri> | null

URL of the next page, or null if last page.

previous · string<uri> | null

URL of the previous page, or null if first page.