Skip to content

List all published events

Request

Retrieve a list of published events that match the given criteria.

Security
SessionKey(Required scopes: publiccustomeradministrator)
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
regionstring^\d{14}$

If set, only returns events being hosted in the specified region

hoststring^\d{14}$

If set, only returns events being staged by the specified host

titlestring

If set, only returns events whose title matches the specified regular expression

activeboolean

Only returns future events if set to true, or past events if set to false

categorystring

If set, only returns events belonging to the specified category

subcategorystring

If set, only returns events belonging to the specified subcategory

featuredboolean

Only returns featured events if set to true, or non-featured events if set to false.

sortstring

If set, determines how the returned events list is sorted

Enum:"alphabetical""published""popularity""start"
orderstring

If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order.

Default:"asc"
Enum:"asc""desc"
curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/events?records=25&page=1&region=string&host=string&title=string&active=true&category=string&subcategory=string&featured=true&sort=alphabetical&order=asc' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The list of published events 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-9)
Response
{
  "page": 1,
  "records": 25,
  "entries": [
    { … }
  ]
}