For all operations listed below you will need to provide HTTP Request Header Authorization param. For more details see Login/Auth page.

Get the list of countries

Route: /country

Method: GET

Example result

{
    "entities": [
        {
            "name": "Country Name",
            "code2": "AB",
            "code3": "ABC",
            "id": "1",
            "is_eu": "0"
        },
        {
            ...
        }
        ...
    "result": true

In the country object:

  • name: name of the country
  • code2: standard 2 letter country code
  • code3: standard 3 letter country code
  • id: internal identifier of the country object
  • is_eu: indicates if the country resides in Europe

Get country by internal ID

Route: /country/{internal_id}

Method: GET

Example result

{
    "entity": {
        "name": "Country Name",
        "code2": "AB",
        "code3": "ABC",
        "id": "1",
        "is_eu": "0"
    },
    "result": true
}