v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Lookups

Get Cities

Retrieves a list of cities within a specified country, optionally filtered by CountryID.

get/v1/cities

Query parameters

CountryIDinteger

The unique identifier of the country to filter the cities.

Response

A list of cities matching the specified criteria.

CityIDinteger nullable

The unique identifier of the city.

CityNamestring nullable

The name of the city.

ShortCitystring nullable

The abbreviated name or code for the city.

RegionIDinteger nullable

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

CountryIDinteger nullable

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