Skip to content

Retrieve event itinerary

Request

Retrieve a list of events, past and future, that the account has tickets for.

Security
SessionKey(Required scopes: customeradministrator)
Path
numberstringrequired

Alphanumeric identifier of the user account

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

Only returns future events if set to true, or past 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/accounts/{number}/events?records=25&page=1&active=true&sort=alphabetical&order=asc' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The event itinerary 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": [
    { … }
  ]
}