v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Zip Code

Retrieve Zip Code

Retrieves a specific Zip Codeq.

get/public/user/zip_code/retrieve/{zip_code_id}

Path parameters

zip_code_idstring required

ID of the Zip Code to retrieve

Response

Successful Zip Code Retrieve

messagestring

Status message for the retrieval.

Example response

{
  "data": {
    "subdivision_id": "ru-irk",
    "zip_code_alias": "kt3",
    "zip_code_id": 123,
    "zip_code_node_count": 1234
  },
  "message": "Zip Code successfully retrieved."
}