Skip to main content
GET
/
public
/
user
/
zip_code
/
retrieve
/
{zip_code_id}
Retrieve Zip Code
curl --request GET \
  --url https://api.byteful.com/1.0/public/user/zip_code/retrieve/{zip_code_id} \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'
{
  "data": {
    "subdivision_id": "ru-irk",
    "zip_code_alias": "kt3",
    "zip_code_id": 123,
    "zip_code_node_count": 1234
  },
  "message": "Zip Code successfully retrieved."
}

Documentation Index

Fetch the complete documentation index at: https://documentation.byteful.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Private-Key
string
header
required

Private API key for user-level authentication.

​
X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Path Parameters

​
zip_code_id
string
required

ID of the Zip Code to retrieve

Response

200 - application/json

Successful Zip Code Retrieve

Zip Code retrieve was successful.

​
data
object

Retrieved Zip Code item details.

​
message
string

Status message for the retrieval.