---
title: "Search Zip Code"
method: GET
path: "/public/user/zip_code/search"
tags: ["Zip Code"]
---

# Search Zip Code

`GET /public/user/zip_code/search`

Search Zip Code entries using various filters.

## Query parameters

- `zip_code_id` integer
- `zip_code_alias` string
- `subdivision_id` string
- `zip_code_node_count` integer
- `per_page` integer
- `page` integer
- `sort_by` string

## Response `200`

Successful Zip Code search

- ZipCodeSuccessfulSearchResponse — Zip Code search was successful.
  - `data` object[] — Array of Zip Code items matching the search criteria up to the limit of per_page paramater.
    - `subdivision_id` string
    - `zip_code_alias` string
    - `zip_code_creation_datetime` string, date-time
    - `zip_code_id` integer
    - `zip_code_last_update_datetime` string, date-time
    - `zip_code_node_count` integer
  - `item_count` integer — Total number of Zip Code 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 Zip Code items returned per page.
  - `total_count` integer — Total of Zip Code 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)