Skip to content

List events

Request

Retrieve a list of all events registered by this event host.

Security
SessionKey(Required scopes: customeradministrator)
Path
hostintegerrequired

Unique identifier of the requested host

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
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

publicboolean

Only returns public events if set to true, or private events if set to false.

tiernumber

Only returns events associated with the specified tier.

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/hosts/{host}/events?records=25&page=1&title=string&active=true&public=true&tier=0&sort=alphabetical&order=asc' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

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