Listing and viewing event summaries
As an event coordinator, this workflow can be used to view the list of all events and a summary of event details along with trip-level information (e.g., booking status) for each traveler. Use the following APIs to list the events, their summaries, and trip details.
Note: A deleted event cannot be listed or viewed.
| Step | Name | Endpoint | Details |
|---|---|---|---|
| 1. | List events | /v2/events/list | List events that match the specified criteria in the request. Request body requires: listEventType and filters. The listEventType field should contain either UPCOMING, PAST_OR_COMPLETED, or CANCELLED_EVENT depending on the type of the event. The filters object can be used to filter the list by user, status, name, company, and date range.Response will contain: The list of all events matching the request criteria. |
| 2. | Get event summaries | /v2/events/summaries | View the summary of selected events. This endpoint will list all event summaries associated with the userId of the organizer, or the companyId.Request body requires: Either the userId of the event organizer or the companyId. Additionally, you can provide the tripIds associated with the events to refine the response.Response will contain: tripId of the bookings made by travelers who were invited to the event, along with the event booking guidelines, RSVP status of the traveler, and other event information.Other APIs will use: tripId |
| 3. | Get trip details | /v3/trips/{tripId}/detail | View a trip and all its associated information. For events, this trip API can be used to find out if the traveler has made the necessary bookings for the event and to review the status of those bookings. Request body requires: tripIdResponse will contain: Information about all the bookings made for the event by a traveler. Details such as the PNR ID, ticket status, date of travel, traveler details, ancillaries, payment methods used, and other relevant information about the trip can be found in the response. |