These docs are for v2017-01-01. Click to read the latest docs for v2021-03-10.

List all events

get

https://sandbox.xola.com/api/events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

seller

string

required

The Seller ID

experience

string

The Experience ID

start

date-time

The start date of the trip as an integer unix timestamp, offset for UTC

end

date-time

The end date of the trip as an integer unix timestamp, offset for UTC

reserved

boolean

Only return events that have reserved bookings

open

int32

Only return events who have more than the given number of open seats

closed

boolean

Only return events not in the experience schedule with zero open count and zero bookings. Cannot use this filter if open is used

format

string

Response format. Use roster to return all matching trips as a roster in an excel file

aggregate

string

Return aggregated information for the given keys. One or more of demographics, addons, orderNotes, guestStatus

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

403403