Skip to navigation

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
Your retailer identifier, provided during onboarding. It must be a retailer your API key was issued for.
X-TT-PlatformenumRequired
Identifies the platform the request comes from.
Allowed values:

Query parameters

locationIdstringRequiredformat: "^[1-9]\d*$">=1 character
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.

limitintegerOptional1-1000Defaults to 50
Maximum number of results to return.
offsetintegerOptional>=0Defaults to 0
Number of results to skip for pagination.

Response headers

X-RateLimit-Limitinteger
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-Remaininginteger
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.
datalist of objectsOptional
List of entities in the current page.
paginationobjectOptional
Pagination metadata.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error