v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB

Lookups

Get States

Retrieves a list of regions (states or provinces) within a specified country, optionally filtered by CountryID.

get/v1/states

CountryIDinteger

The unique identifier of the country to filter the regions.

A list of regions matching the specified criteria.

RegionIDinteger nullable

The unique identifier of the region.

RegionNamestring nullable

The name of the region.

ShortRegionstring nullable

The abbreviated name or code for the region.

CountryIDinteger nullable

The unique identifier of the country to which the region belongs.