List events

Returns a paginated list of events in a location. Pass query to narrow the list to events matching a search term.

Authentication

X-TT-API-Keystring
API Key authentication via header

Headers

X-TT-RetailerstringRequired
Retailer public ID
X-TT-PlatformenumRequired
Identifies the platform the request comes from.
Allowed values:

Query parameters

locationIdstringRequiredformat: "^[1-9]\d*$"
Location ID to filter events by
querystringOptional0-50 characters

Free-text search across event name, venue, category, cast and search keywords. Combines with locationId. Omit it, or send it blank, for the unfiltered catalog.

limitstringRequired
Maximum number of results to return.
offsetstringRequired
Number of results to skip for pagination.

Response

Paginated list of events.