v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Addresses::Country

List Countries

List all countries, each with its ISO 3166-1 alpha-2 code (iso2). Use a country's iso2 as the country_code when setting an address, and as the {country_id} path segment when listing its regions.

get/addresses/countries

Response

iso2string required

ISO 3166-1 alpha-2 code (e.g. "US"). Pass this as country_code when setting an address.

iso3string

ISO 3166-1 alpha-3 code (e.g. "USA").

namestring required

English country name (e.g. "United States").

localized_namestring

Country name localized to the request's locale.

has_regionsboolean

True if the country has regions/states to choose from.

Example response

[
  {
    "iso2": "US",
    "iso3": "USA",
    "name": "United States",
    "localized_name": "United States",
    "has_regions": true
  }
]