Skip to main content
POST
Search cities

Authorizations

Authorization
string
header
required

API Token used for authentication. Example: "Authorization: Bearer {token}"

Body

application/json
stateIds
integer<int32>[] | null

Up to 100 positive state IDs. Results may belong to any supplied state and must also match any country filter.

Maximum array length: 100
countryCodes
string[] | null

Up to 250 two-letter country codes. Results may belong to any supplied country. Codes are trimmed and case-insensitive.

Maximum array length: 250
query
string | null

A literal, case-insensitive substring of the name. Leading and trailing whitespace is ignored.

Maximum string length: 100
pageSize
integer<int32>

The maximum number of results to return. Defaults to 100.

Required range: 1 <= x <= 100
cursor
string | null

The cursor from the previous response. Omit for the first page. Keep the same filters; pageSize may change.

Maximum string length: 2048

Response

OK

items
object[]
required

The geographic records in this page

nextCursor
string | null

The cursor for the next page. Omitted when no more results remain. Expires 30 minutes after the first page.