v1Resources/Locations/getList countries

List countries

Lists supported country codes and location-field requirements. Filter by q, hasRegions or includeInactive.

get/api/v1/reference/countries
locations:read
Query parameters
qstringoptional
hasRegionsbooleanoptional
includeInactivebooleanoptional
Response
countriesarray of objectoptional
codestringoptional
namestringoptional
dialCodestringoptional
hasRegionsbooleanoptional
usesStatebooleanoptional
requiresStatebooleanoptional
stateTypestringoptional
activebooleanoptional
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Retry a credit grant with the same idempotency key.
get/api/v1/reference/countries
Your API key
q
hasRegions
includeInactive
{}

Guides that use this resource