Get Regions

GET /regions
O auth2

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.

  • Accept-Language string

    Returns the requested resources translated according to the passed languages (see translatable resources)

    Minimum length is 1.

Query parameters

  • country-code string Required

    Minimum length is 1.

  • id array[string]

    ID(s) to be considered for filtering

    At least 1 element. Minimum length of each is 1.

  • offset string(positive-integer)

    Offset for the results to be returned

    Default value is 0.

  • limit string(positive-integer)

    Limitation for the number of results to be returned, number between 1 and 1000.

    Format should match the following pattern: ^([1-9]|[1-9][0-9]{1,2}|1000)$. Default value is 25.

Responses

  • 200 application/json

    Successful operation

    Hide response attributes Show response attributes object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • id string Required

        Minimum length is 1.

      • name string Required

        Minimum length is 1.

      • code string | null Required

        Minimum length is 1.

    • meta object Required

      Additional properties are NOT allowed.

      Hide meta attributes Show meta attributes object
      • offset integer Required

        Minimum value is 0. Default value is 0.

      • limit integer Required

        Minimum value is 0. Default value is 25.

      • totalCount integer Required

        Minimum value is 0.
GET /regions 
curl \
 --request GET 'https://api.staging.pexipengage.com/enterprises/acme/regions?country-code=BE' \
 --header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 --header "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 --header "Accept-Language: en *"
Response examples (200) 
{
  "data": [
    {
      "id": "123",
      "name": "string",
      "code": "string"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 25,
    "totalCount": 42
  }
}