Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Lookups

Get Regions

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

get/v1/regions

Query parameters

CountryIDinteger

The unique identifier of the country to filter the regions.

RegionIDinteger

The unique identifier of the region to filter the results.

Response

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.