List countries

Reference catalogue of supported countries.

GET /generals/countries

List countries

cURL

curl --request GET \
  --url https://api.piriod.com/generals/countries/ \
  --header 'Authorization: <api-key>'

200

{
  "count": 142,
  "results": [
    {
      "id": "CL",
      "name": "<string>",
      "name_default": "<string>",
      "phone_code": "+56",
      "three_code": "CHL",
      "has_regulation": true,
      "tax_percent": 123,
      "locale": "<string>"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

Authorization · string · header · required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

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

Response

200 - application/json

Paginated country 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.