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-Retailer
Your retailer identifier, provided during onboarding. It must be a retailer your API key was issued for.
X-TT-Platform
Identifies the platform the request comes from.
Allowed values:
Query parameters
locationId
Location ID to filter events by
query
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.
limit
Maximum number of results to return.
offset
Number of results to skip for pagination.
Response headers
X-RateLimit-Limit
How many requests this API key may make for this retailer in the current window. Sent only when the request was counted against that limit. A response served from cache was not counted and repeats the value it was cached with.
X-RateLimit-Remaining
How many requests this API key has left for this retailer in the current window. Sent only when the request was counted against that limit. A response served from cache was not counted and repeats the value it was cached with.
Response
Paginated list of events.
data
List of entities in the current page.
pagination
Pagination metadata.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error