List
Last updated
Last updated
The event list endpoint allows you to list events for a specific search. If a search is not provided, it will return all events.
The example below searches for an event. This returns an array of matched events with a list of attendees and their states.
The response will contain an array of pathway reward combination objects containing pathway details and events (which is the list of events on the pathway). This is the same structure as the event webhook payload.
The attendee object will contain a guid which is used in the consume endpoint for events. This will allow integrations to set the booking state if the intention is to manage attendance of events via external systems.
Key
Type
search
Array String (pathway / event name or ID)
DEPRECATED
keyword
String (Keyword search of pathways, events or eventIDs)
Key
Type
pathway
Object. The name and SKU of the related pathway.
events
Array. A list of events.
Key
Type
ID
String. ID or SKU reference of the event.
name
String. Name of the event.
start
String. Start time of the event.
end
String. End time of the event.
venue
Object. Venue information.
booked
String. Number of registered attendees.
available
String. Available capacity (Unlimited or number)
attendees
Array. A list of registered attendees.
Key
Type
guid
String. A GUID of the attendee.
state
String. The state of the attendance (booked, absent, attended).
firstname
String
lastname
String
String
country
String
city
String