Skip to Content
OpenRoam Docs
Reference data

List countries

Lists every country and territory with its codes, English name, calling code and flag.

GET
/v1/common/countries

Lists every country and territory with its codes, English name, calling code and flag.

Returns { items }, the whole list ordered by countryCode, without paging. countryCode is the ISO 3166-1 alpha-2 code every service filters and reports by. The endpoint takes no query parameters; an unknown parameter returns 400 with code 10001.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Response Body

OK

  1. response

The complete country reference list, ordered by country code. The list is small and fixed, so it is not paged.

items*array<>
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/common/countries'
Example Response
{  "items": [    {      "countryCode": "string",      "numericCode": "string",      "name": "string",      "dialCode": "string",      "flagUrl": "string"    }  ]}