Get Cities
GET https://{{host}}/v3/cities?filter[name]=London&filter[country.id]={{country.id}}
Returns a list of cities. Maximum page size is 1000. Default page size is 1000.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter[name] | string | string - Filters by city name field. |
-
Allow blank - Yes.
-
Allow array - Yes. | |
filter[country.id]| string | |integer- A country.id field. -
Allow blank - Yes.
-
Allow array - Yes. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"data":[{"id":"79c1ee51-a2dd-4fb2-8c08-ab9120909118","type":"cities","attributes":{"name":"Springfield"},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/country","related":"https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/country"}},"region":{"links":{"self":"https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/region","related":"https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/region"}}}}]}