Cities

The city is a subset of the state and every state has a list of cities and city IDs. The city is also a targeting feature in Kayzen Platform along with State.

Returns a list of cities that contain the search query. If no search query is specified, returns all cities.

πŸ“˜

GET /api/v1/meta/cities

Field

Param

Description

q

string(optional)

Field can be used as search query

state_ids

Arrayint

State ID is a unique ID for every state assigned in Kayzen Platform

country_ids

Arrayint

Country ID is a unique ID for every country assigned in Kayzen Platform

per_page

int(optional)

Number of rows per page. Default Value- 25

page

int(optional)

Returns page number. Default Value- 1 page

curl -X GET \
'[HOST]/api/v1/meta/cities?page=1&per_page=25&q=berlin' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
{
  "data":[
    {
      "id":100104,
      "name":"Berlin",
      "state_id":3535,
      "state_name":"Schleswig-Holstein",
      "country_id":93,
      "country_name":"Germany",
      "group":false
    },{
      "id":49418,
      "name":"Berlin",
      "state_id":164,
      "state_name":"Antioquia",
      "country_id":59,
      "country_name":"Colombia",
      "group":false
    }
  ],
  "meta":{
      "current_page":1,
      "total_pages":29,
      "total_entries":58
    }
}