---
title: "Search City"
method: GET
path: "/public/user/city/search"
tags: ["City"]
---

# Search City

`GET /public/user/city/search`

Search City entries using various filters.

## Query parameters

- `city_id` string
- `city_name` string
- `subdivision_id` string
- `city_timezone` string
- `city_is_populous` boolean
- `city_alias` string
- `city_example_postcode` string
- `city_latitude` string
- `city_longitude` string
- `city_node_count` integer
- `per_page` integer
- `page` integer
- `sort_by` string

## Response `200`

Successful City search

- CitySuccessfulSearchResponse — City search was successful.
  - `data` object[] — Array of City items matching the search criteria up to the limit of per_page paramater.
    - `city_alias` string
    - `city_creation_datetime` string, date-time
    - `city_example_postcode` string
    - `city_id` integer
    - `city_is_populous` boolean
    - `city_last_update_datetime` string, date-time
    - `city_latitude` number
    - `city_longitude` number
    - `city_name` string
    - `city_node_count` integer
    - `city_population` integer
    - `city_timezone` string
    - `subdivision_id` string
  - `item_count` integer — Total number of City items returned in the data field.
  - `message` string — Status message for the search.
  - `page` integer — Current page number of the search results returned.
  - `per_page` integer — Number of City items returned per page.
  - `total_count` integer — Total of City items that match the search filter.

---

[API](https://skmtc.dev/byteful/apis/byteful-public-user-api.md) · [All operations](https://skmtc.dev/byteful/apis/byteful-public-user-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/byteful/byteful-public-user-api/revisions/3db1a6fc0099/schema)