v1Resources/Locations/getList states and regions

List states and regions

Lists states or regions by country, text or type. Without country, results are paginated using limit and cursor; with country, the full matching list is returned.

get/api/v1/reference/states
locations:read
Query parameters
countrystringoptional
qstringoptional
typestringoptional
includeInactivebooleanoptional
limitintegeroptional
cursorstringoptional
Response
nextCursorstringoptional
statesarray of objectoptional
countryCodestringoptional
codestringoptional
namestringoptional
typestringoptional
activebooleanoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
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/states
Your API key
country
q
type
includeInactive
limit
cursor
{}

Guides that use this resource