Sign in
latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api
events

Get Event info

get/api/events/info/{id}

Path parameters

idstring required

Query parameters

webstring
underShopstring
posOperationMode'OPERATOR' | 'KIOSK'
posboolean
channelstring
localestring

Get the info for a specific language

Response

OK

_idstring required

The ID of the event

namestring required

The name of the event

startstring date-time required

An ISO timestamp indicating when the event starts

endstring date-time required

An ISO timestamp indicating when the event ends

urlstring

The url of the event

sloganstring

The slogan of the event

descriptionstring

A description about the event. Description is in RichText - JSON format.

locationNamestring

The name of the location where the event takes place

imagestring

An image for the event

accentColorstring

The accent color of the event page

sellerIdstring

The ID of the seller owning this event

sellStartstring date-time

An ISO timestamp indicating when the event sale starts

ticketShopHeaderstring

A header image for the ticket shop of the event

useTimeSlotsboolean

Whether the event uses time slots.

saleStatus'onSale' | 'planned' | 'past' | 'soldOut'

The status of event sale

underShopIdstring

The ID of the selected under shop

unlockMode'none' | 'couponCode'

Sets how event is locked, e.g. by coupon code.

channelIdstring

The ID of the selected channel

seatingboolean

Whether seating is active or not

seatingEventIdstring

The ID of the seating event

seatingChildEventIdsstring[]

The seating event IDs of the child events. Usually used to render maps for season ticket events

seatingConfigurationsobject

Settings to control the behaviour of maps

contingentsstring[]

An array of contingents IDs

themestring

The theme of the event

taxRatenumber float

The default tax rate of the event

maxnumber float

Maximum amount of tickets per order

minnumber float

Minimum amount of tickets per order

vnumber float

The remaining volume of the event

cXvnumber float
cXfnumber float
ccXfnumber float
startingPricestring

The starting price of the event

showTimeRangeInTicketboolean

Whether to show the start and end time of the event on a ticket PDF or not

showTimeRangeInListingboolean

Whether to show the start and end time of the event in listings or not

showCountdownboolean

Whether to show the countdown till the sale of the event starts or not

showOtherEventsboolean

Whether to show other events of the seller on the event page

accountsModuleboolean

Whether customer accounts for the event are enabled or not

stripe_api_keystring
currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK'

The default currency of the event

timezonestring

Timezone of event

ticketShopHeaderTextstring