Countries

Countries provide geo-locality within the system, mainly to your customers.

Country

code	string <iso-3166-alpha-2> A two-letter country code.
name	string [ 1 .. 255 ] characters Name of country.

{"code": "NL",
"name": "The Netherlands"
}

Retrieve all countries

Retrieve a list of countries supported within the system.

SecurityOAuth2 and ApiKey

Request

query Parameters

limit	integer <int32> [ 0 .. 1000 ] Default: 25 Limits the amount of resources in result.
offset	integer <int64> >= 0 Default: 0 Offset of resources in result.

Responses

200

Successful response.

Response Schema: application/json

object >= 0 properties

Applied query parameters, including defaults.

limit	integer <int32> [ 0 .. 1000 ] Default: 25 The applied value of the limit query parameter on the resources in result.
offset	integer <int64> >= 0 Default: 0 The applied value of the offset query parameter on the resources in result.
property name* additional property	any

Array of objects (Country) >= 0 items

List of countries.

Array (>= 0 items)

code	string <iso-3166-alpha-2> A two-letter country code.
name	string [ 1 .. 255 ] characters Name of country.

total

integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/system/countries

Response samples

200
default

application/json

{"query": {"limit": 25,
"offset": 0
},
"result": [{"code": "NL",
"name": "The Netherlands"
}
],
"total": 3255
}

Retrieve country

Retrieve a single country by its code.

SecurityOAuth2 and ApiKey

Request

path Parameters

country-code

required

string <iso-3166-alpha-2>

The code of the country you want to manage.

Example: NL