List Event Instances

GET

/{tenant}/event-instances

Production server
Development server
Local development server

Retrieve a paginated list of Event Instances

Authorizations

apiKey

Parameters

Path Parameters

tenant

required

string

Tenant slug

Query Parameters

limit

integer

default: 10

Number of items to return

page

integer

default: 1

Page number

sort

string

Sort field (prefix with - for descending)

where

Query filters

object

Responses

200

Successful response

object

docs

Array<object>

object

required

string

createdAt

string format: date-time

updatedAt

string format: date-time

tenant

Tenants ID

string

title

string

ticketingSystem

string

ticketingSystemId

string

showCustomAttributesField

string

Allowed values: yes no

hidden

boolean

elevent

object

showTimeId

string

eventId

string

eventUrlName

string

spektrix

object

instanceId

string

eventId

string

tessitura

object

performanceId

string

productionSeasonId

string

keywords

string

availability

string

generalBooking

object

bookingLinkLabel

string

bookingLinkURL

string

lineup

object

ticketId

string

eventId

string

ticketName

string

ticketDescription

string

pricing

object

price

number

currency

string

availability

object

quantityAvailable

number

quantitySold

number

saleStart

string format: date-time

saleEnd

string format: date-time

ticketStatus

string

Allowed values: available sold_out on_sale_soon sale_ended cancelled

ticketType

string

Allowed values: general vip early_bird student senior group season_pass

syncData

string

totalDocs

integer

limit

integer

totalPages

integer

page

integer

pagingCounter

integer

hasPrevPage

boolean

hasNextPage

boolean

prevPage

integer

nullable

nextPage

integer

nullable