Get localities list by postal code

GET /api-v1/list/localities/{postalCode}

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Path parameters

postalCode string Required

postalCode

Responses

200 */*

OK
Hide response attributes Show response attributes object
- bfsCode string
- name string
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/list/localities/{postalCode}

curl \
 --request GET 'https://wyzio.app/api-v1/list/localities/{postalCode}' \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "bfsCode": "string",
    "name": "string"
  }
]