/v1/data/postcode_segment

GET /v1/data/postcode_segment

Summary

Retrieve segment information for a given postcode.

Request Headers

Header	Value	Description
Authorization	Bearer API_TOKEN	The API token required for authentication.

Query Parameters

Parameter	Type	Required	Description
postcode	string	Yes	The postcode to retrieve segment data for. Can be a 4-digit or 6-character postcode.

Responses

200: Successful Response

The successful response returns a JSON object with the following structure:

{
  "data": {
    "segment": "string",
    "segment_description": "string",
    "postcode": "string"
  },
  "total_records": 1,
  "message": "Get postcode segment",
  "status": "OK"
}