v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Account Information
Public API

List states and provinces for a country by Country ID

Returns the list of states or provinces for the specified country, sorted alphabetically by abbreviation (options[].label). Each item follows StateProvinceSchema: label is the subdivision abbreviation (e.g. "UT"), not the full name; name is the full subdivision name; iso is the ISO 3166-2 code (e.g. "US-UT"). Use a countryId from GET /api/v1/meta/countries/options (the id field on the row for the country) so it matches the countries list.

OAuth Scopes: field

get/api/v1/meta/provinces/{countryId}

Path parameters

countryIdinteger required

Numeric id of the country, taken from the countries options list. Use the id of the target country from GET /api/v1/meta/countries/options.

Response

List of states/provinces. The options array items match StateProvinceSchema; label is always the subdivision abbreviation used for sorting.