Data API · Reference
List countries
GET/api/v1/datas/countries
Returns countries available to the authenticated account.
Bearer authentication required · service: data_apiReference only — this page never sends API requests or exposes token controls.
Response formats
When format is listed below, use json for the response documented here, or csv and xml for downloads. JSON uses camelCase by default; set case=snake_case when supported for legacy key names. Nested response fields use dot notation; [] denotes an array item and {key} a dynamic object key.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | Required | Response format. Allowed: json, csv, xml. |
| page | integer | Optional | Page number. Default: 1. Minimum 1. |
| perPage | integer | Optional | Items per page. Default: 20. Minimum 1; maximum 100. |
Response attributes
| Attribute | Type | Description |
|---|---|---|
| items | array | Country records. |
| items[].id | integer | Country ID. |
| items[].name | string|null | Country name. |
| items[].shortName | string|null | Country short name. |
| items[].flag | string|null | Country flag URL. |
| meta | object | Pagination metadata. |
| meta.currentPage | integer | Current page number. |
| meta.perPage | integer | Requested page size. |
| meta.total | integer | Total number of matching records. |
| meta.lastPage | integer | Last available page number. |
| meta.from | integer|null | Position of the first item on this page. |
| meta.to | integer|null | Position of the last item on this page. |
| links | object | Pagination URLs. |
| links.first | string | URL of the first page. |
| links.last | string | URL of the last page. |
| links.previous | string|null | URL of the previous page, when available. |
| links.next | string|null | URL of the next page, when available. |