Get regions

GET /regions

OAuth2

Get regions with filtering

Headers

Authorization string

Bearer token used for authorization

Minimum length is 1.
X-Correlation-Id string

Unique identifier to allow referencing a particular transaction or event chain

Minimum length is 1.

Query parameters

id array[string]

ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
code array[string]

Code(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
level array[integer]

Level(s) to be considered for filtering

At least 1 element. Minimum value of each is 0.
parent-id array[string]

Parent ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
country-code string Required

Country to be considered for filtering (ISO 3116)

Minimum length is 1.

Responses

200 application/json

Successful operation
Hide response attribute Show response attribute object
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  code string | null Required
  
  Minimum length is 1.
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  id string Required
  
  Minimum length is 1.
  
  name string Required
  
  Minimum length is 1.
  
  level integer Required
  
  Level 0 being the smallest hierarchical sub-region
  
  parentId string | null Required
  
  Minimum length is 1.

GET /regions

curl \
 -X GET https://api.development.pexipengage.com/enterprises/acme/regions?country-code=string \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"

Response examples (200)

{
  "data": [
    {
      "code": "9000",
      "countryCode": "BE",
      "id": "123",
      "name": "New York",
      "level": 42,
      "parentId": "123"
    }
  ]
}