Skip to main content
GET
cURL

Authorizations

Headout-Auth
string
header
required

Query Parameters

offset
integer
default:0

Number of items to skip before starting to collect the result set.

limit
integer
default:10

Maximum number of items to return.

Response

200 - application/json

Successful response

items
object[]

The cities in this page of results.

nextUrl
string | null

Full URL to fetch the next page of results. Null if on the last page.

prevUrl
string | null

Full URL to fetch the previous page of results. Null if on the first page.

total
integer

Total number of cities across all pages.

nextOffset
integer | null

Offset value to use in the next request to retrieve the following page.