Should you notice any errors in our documentation, please don’t hesitate to contact us. Thank you!

List

GET

https://www-staging.givve.com//api/postal_data

Last modified:2026-02-19 11:26:29

Postal Data List

Accessible By

all

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://www-staging.givve.com//api/postal_data?postal_code=123' \
--header 'Accept-Version: v2' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "meta": {
        "total_pages": 0,
        "current_page": 0,
        "page_size": 0,
        "total_entries": 0
    },
    "data": [
        {
            "id": "string",
            "post_code": "string",
            "postal_code_area": "string",
            "town_name": {},
            "town_name_affix": {},
            "display_name": {},
            "associated_postal_code_areas": [
                "01"
            ],
            "associated_districts": [
                "string"
            ]
        }
    ],
    "links": {
        "self": "http://example.com",
        "first": "http://example.com",
        "prev": "http://example.com",
        "next": "http://example.com",
        "last": "http://example.com"
    }
}

Modified at 2026-02-19 11:26:29

List

Postal Data List#

Accessible By#

Request

Responses

Postal Data List

Accessible By