Skip to content

List supported regions

Request

Retrieve a list of supported regions where events can be staged.

Security
SessionKey(Required scopes: customeradministrator)
Query
recordsinteger

The number of records per page that should be returned

Default:25
pageinteger

The number of the results page to return

Default:1
activeboolean

Returns regions with one or more upcoming events, if true, or regions without upcoming events if false.

curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/regions?records=25&page=1&active=true' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The list of supported regions was successfully retrieved.

Bodyapplication/json
totalinteger

The total number of results available

pageinteger

The number of the results page returned

recordsinteger

The maximum number of results returned per page

entriesArray of objects(response-6)
Response
{
  "page": 1,
  "records": 25,
  "entries": [
    { … },
    { … }
  ]
}