Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Zip Code

Search Zip Code

Search Zip Code entries using various filters.

get/public/user/zip_code/search

Query parameters

zip_code_idinteger

Filter by specific zip code ID

zip_code_aliasstring

Filter by zip code alias

subdivision_idstring

Filter by subdivision ID

zip_code_node_countinteger

Filter by zip code node count

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successful Zip Code search

item_countinteger

Total number of Zip Code items returned in the data field.

messagestring

Status message for the search.

pageinteger

Current page number of the search results returned.

per_pageinteger

Number of Zip Code items returned per page.

total_countinteger

Total of Zip Code items that match the search filter.

Example response

{
  "data": [
    {
      "subdivision_id": "ru-irk",
      "zip_code_alias": "kt3",
      "zip_code_id": 123,
      "zip_code_node_count": 1234
    }
  ],
  "item_count": 1,
  "message": "Zip Code search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}