Events​
Endpoints to interact with events
Operations​
Get Events API Endpoint​
Authorizations​
Parameters​
Query Parameters
Filter by from date
"2021-01-01"Filter by to date
"2021-01-01"Comma-separated. Core: published, elapsed (event ended: end < now), not_on_sale (onSale=0), archived, unpublished (published=0), invite_only. scheduled (onSaleDate in future), on_sale (onSale=1 or onSaleDate has passed), sold_out (v1: sum(soldCount) >= sum(quantity) excluding tier-linked types), pending (custom field pendingStatus=1; v1 Pending Status column), approved (else branch; not pendingStatus=1).
"published,on_sale"Include related and additional data by total_ticket_sold,total_ticket,ticket_types
"ticket_types"Comma-separated category IDs (system_plug_eventManager_selectedCategories.categoryId). Returns events linked to any of the listed categories.
"1,2"Responses​
Question list
Create a new event​
Create event. Supports both JSON and multipart/form-data for file uploads.
Authorizations​
Request Body​
PHP date format string for end time display
Date when event was published (Unix timestamp format)
Custom formatted start date string for display
Whether the event is published and visible
Whether the event is featured/highlighted
Numeric sort order of the event in lists (lower = first)
Whether the event is currently on sale
Whether the event requires an invitation to register
Event title
Search engine friendly URL slug
Full event description
Short event description
Text to display when event is not on sale
Whether to skip this event in public lists
Whether to skip this event in API lists
Event start timestamp (Unix timestamp)
Event end timestamp (Unix timestamp)
PHP date format string for start date display
Date when tickets go on sale (Unix timestamp)
Registration cutoff timestamp (Unix timestamp)
Maximum number of tickets available
Venue name
Venue address line 1
Venue address line 2
Venue city
Venue state/province
Venue postal/zip code
Venue country
Whether to display venue name
Whether to display venue address line 1
Whether to display venue address line 2
Whether to display venue city
Whether to display venue state
Whether to display venue postal code
Venue latitude coordinate
"float"Venue longitude coordinate
"float"upload file image
upload file image
Custom URL path to override the default event URL
Whether to display the registration cutoff date
Organization or person presenting the event
Whether a promo code is required for registration
Whether to hide this event in the box office
Whether to display an embedded map for the venue
Whether the wave time selector is shown as the first purchase question
When true, captains cannot sign waivers on behalf of other attendees (event-level, v1 parity).
Receipt emails data
Receipt text data
event tag, Example request: eventTags[0], eventTags[1]
Event select multiple categories
Responses​
Created event
GetEvent by ID API Endpoint​
Delete Event by ID​
Update event​
Update event by Id. Supports both JSON and multipart/form-data for file uploads.
Authorizations​
Parameters​
Path Parameters
Events Id
"int64"Request Body​
PHP date format string for end time display
Date when event was published (Unix timestamp format)
Custom formatted start date string for display
Whether the event is published and visible
Whether the event is featured/highlighted
Numeric sort order of the event in lists (lower = first)
Whether the event is currently on sale
Whether the event requires an invitation to register
Event title
Search engine friendly URL slug
Full event description
Short event description
Text to display when event is not on sale
Whether to skip this event in public lists
Whether to skip this event in API lists
Event start timestamp (Unix timestamp)
Event end timestamp (Unix timestamp)
PHP date format string for start date display
Date when tickets go on sale (Unix timestamp)
Registration cutoff timestamp (Unix timestamp)
Maximum number of tickets available
Venue name
Venue address line 1
Venue address line 2
Venue city
Venue state/province
Venue postal/zip code
Venue country
Whether to display venue name
Whether to display venue address line 1
Whether to display venue address line 2
Whether to display venue city
Whether to display venue state
Whether to display venue postal code
Venue latitude coordinate
"float"Venue longitude coordinate
"float"upload file image
upload file image
Custom URL path to override the default event URL
Whether to display the registration cutoff date
Organization or person presenting the event
Whether a promo code is required for registration
Whether to hide this event in the box office
Whether to display an embedded map for the venue
Whether the wave time selector is shown as the first purchase question
When true, captains cannot sign waivers on behalf of other attendees (event-level, v1 parity).
Receipt emails data
Receipt text data
event tag, Example request: eventTags[0], eventTags[1]
Event select multiple categories
Array of waiver IDs required on the standard waiver
Array of waiver IDs required on the day of the event
Responses​
Updated events object
List ticket type tags​
Returns a list of event tags
Authorizations​
Parameters​
Responses​
Event tags list
Duplicate event​
Duplicate event by Id and return the new event. JSON body requires title, sefUrl, start, and end; optional cutOff, timezone, and processorId.
Authorizations​
Parameters​
Path Parameters
Source event ID to duplicate
"int64"Request Body​
Responses​
Duplicate event
Find Event by ID​
Find events that match the provided input parameters​
Authorizations​
Parameters​
Query Parameters
Search text in just the title - must match exactly unless you use a % to match any char
Search text in Title, Description, Venue, Venue Address - uses wildcard search
Includes events whose start date is on or after the provided date and time. Value should be a unix timestamp in UTC.
Includes events whose start date is before the provided date and time. Value should be a unix timestamp in UTC.
Includes events whose ending date is on or after the provided date and time. Value should be a unix timestamp in UTC.
Includes events whose ending date is before the provided date and time. Value should be a unix timestamp in UTC.
Filters events based on if they've been marked as onsale. This filter ignores an event's end date and cutoff. If toEnd isn't includes then past events will still be included.
- all - Matches all events.
- onsale - Only events that are currently marked as onsale.
- upcoming - Only events that have been scheduled to be onsale in the future.
- onsaleupcoming - Events that are currently marked as on sale and events that have been schedule to be marked as on sale.
- offsales - Event that have been marked as offsale.
Filters events based on if they've been published.
- all - Matches all events.
- published - Only events that are currently published.
- upcoming - Only events that have been scheduled to be published in the future.
- publishedupcoming - Events that are currently marked as published and events that have been schedule to be marked as published.
- unpublished - Event that have been marked as published.
Filters events based on the select critera. If provided then onsale, published, and the date filters will be ignored.
- all - Matches all events.
- availableonline - Currently available for purchase online.
- upcomingonline - Only events that have been scheduled to be on sale in the future online.
- availableupcomingonline -Events that currently on sale online or are upcoming.
- availableboxoffice - Currently available for purchase via the box office.
- upcomingboxoffice - Evants that are upcoming for purchase via the box office or are upcoming.
- availableupcomingboxoffice - Currently available for purchase via the box office or are upcoming.
- upcoming - All events who's start date is in the future.
- ongoing - All events who's start date has past but the end date is in the future.
- elapsed - All events who's end date is in the past.
Returns events that have been changed since the provided date. The date is a unix timestamp.
Adds additional details to the results. Supports the following values:
- tags - Include tags.
- waveTimes - Include wave times
- sold - Include tickets sold and total available.
Determins the order the events are returned. Each property can be append with + or -. + indicated sort asc and - sorts deciding. If excluded the column is sorted in asceding sort. Multiple columns a seperated by a comma. You can sort by ordering, title, start, id.
Responses​
Create a new event​
Create event. Supports both JSON and multipart/form-data for file uploads.
Authorizations​
Request Body​
PHP date format string for end time display
Date when event was published (Unix timestamp format)
Custom formatted start date string for display
Whether the event is published and visible
Whether the event is featured/highlighted
Numeric sort order of the event in lists (lower = first)
Whether the event is currently on sale
Whether the event requires an invitation to register
Event title
Search engine friendly URL slug
Full event description
Short event description
Text to display when event is not on sale
Whether to skip this event in public lists
Whether to skip this event in API lists
Event start timestamp (Unix timestamp)
Event end timestamp (Unix timestamp)
PHP date format string for start date display
Date when tickets go on sale (Unix timestamp)
Registration cutoff timestamp (Unix timestamp)
Maximum number of tickets available
Venue name
Venue address line 1
Venue address line 2
Venue city
Venue state/province
Venue postal/zip code
Venue country
Whether to display venue name
Whether to display venue address line 1
Whether to display venue address line 2
Whether to display venue city
Whether to display venue state
Whether to display venue postal code
Venue latitude coordinate
"float"Venue longitude coordinate
"float"upload file image
upload file image
Custom URL path to override the default event URL
Whether to display the registration cutoff date
Organization or person presenting the event
Whether a promo code is required for registration
Whether to hide this event in the box office
Whether to display an embedded map for the venue
Whether the wave time selector is shown as the first purchase question
When true, captains cannot sign waivers on behalf of other attendees (event-level, v1 parity).
Receipt emails data
Receipt text data
event tag, Example request: eventTags[0], eventTags[1]
Event select multiple categories
Responses​
Created event
Find TicketTypes by Event ID​
Returns a list of ticketTypes
Authorizations​
Parameters​
Path Parameters
Event Id of the TicketTypes to return
"int64"Query Parameters
Limit Results to this number
"int64"Limit Results to this number
"int64"Specific columns to select (else * will be selected)
Responses​
Find wave times for the given event.​
Scans a ticket for an event.​
Scans a ticket for an event.
Authorizations​
Parameters​
Path Parameters
The id of the event being scanned.
Request Body​
Responses​
The ticket was successfully scanned.
Scans a ticket for a set of events.​
Scans a ticket for a set of events.
Authorizations​
Request Body​
Responses​
The ticket was successfully scanned.