List cities

get

https://{buzz_key}.api.beeswax.com/rest/v2/ref/cities

Retrieve a list of cities with optional filtering and search capabilities.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

country_code_2

string

country_code_2__in

array of strings

Multiple values may be separated by commas.

country_code_2__in

country_code_2__isempty

boolean

country_code_2__not

string

country_code_2__not_in

array of strings

Multiple values may be separated by commas.

country_code_2__not_in

country_code_3

string

country_code_3__in

array of strings

Multiple values may be separated by commas.

country_code_3__in

country_code_3__isempty

boolean

country_code_3__not

string

country_code_3__not_in

array of strings

Multiple values may be separated by commas.

country_code_3__not_in

geoname

string

geoname__in

array of strings

Multiple values may be separated by commas.

geoname__in

geoname__isempty

boolean

geoname__not

string

geoname__not_in

array of strings

Multiple values may be separated by commas.

geoname__not_in

metro_code

string

metro_code__in

array of strings

Multiple values may be separated by commas.

metro_code__in

metro_code__isempty

boolean

metro_code__not

string

metro_code__not_in

array of strings

Multiple values may be separated by commas.

metro_code__not_in

name

string

name__contains

string

name__in

array of strings

Multiple values may be separated by commas.

name__in

name__isempty

boolean

name__not

string

name__not_contains

string

name__not_in

array of strings

Multiple values may be separated by commas.

name__not_in

order

string

Which field to use when ordering the results.

region_code

string

region_code__in

array of strings

Multiple values may be separated by commas.

region_code__in

region_code__isempty

boolean

region_code__not

string

region_code__not_in

array of strings

Multiple values may be separated by commas.

region_code__not_in

region_name

string

region_name__contains

string

region_name__in

array of strings

Multiple values may be separated by commas.

region_name__in

region_name__isempty

boolean

region_name__not

string

region_name__not_contains

string

region_name__not_in

array of strings

Multiple values may be separated by commas.

region_name__not_in

string

A search term.

Responses

400

Invalid request parameters.

401

Authentication required.

403

Permission denied.

500

Internal server error.

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Cities retrieved successfully.