Get Regions

Retrieves a list of regions (states or provinces), optionally filtered by CountryID or RegionID.

Get Regions

cURL

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/regions \
  --header 'Authorization: <api-key>'

200

[
  {
    "RegionID": 123,
    "RegionName": "<string>",
    "ShortRegion": "<string>",
    "CountryID": 123
  }
]

Authorizations

Authorization · string · header · required

Enter your API key. It's required to authenticate API requests.

Query Parameters

CountryID · integer<int32>

The unique identifier of the country to filter the regions.

RegionID · integer<int32>

The unique identifier of the region to filter the results.

Response

200 - application/json

A list of regions matching the specified criteria.

RegionID · integer<int32> | null

The unique identifier of the region.

RegionName · string | null

The name of the region.

ShortRegion · string | null

The abbreviated name or code for the region.

CountryID · integer<int32> | null

The unique identifier of the country to which the region belongs.