Zip Code

Retrieve Zip Code

Retrieves a specific Zip Codeq.

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

Request

Base URL
https://api.byteful.com/1.0
Auth
API key in header X-API-Private-Key and API key in header X-API-Public-Key
TypeScript
https://skmtc.dev/byteful/apis/byteful-public-user-api/docs/public/user/zip_code/retrieve/:zip_code_id/get.ts
A function with typed inputs. Its response is checked against the schema.

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."
}

Changes

No recorded changes to this operation across all 1 revision of this API.