Sign in

v1

latestOpenAPI 3.1.02026-08-0624411242.2 KB
Events

List events

List all the events that match the specified criteria in the request.

post/v2/events/list

Request body

listEventType'UPCOMING' | 'PAST_OR_COMPLETED' | 'CANCELLED_EVENT'

Type of events

listByTravelerEventsboolean

Whether listing travelers or events.

offsetinteger

Indicates from where in the list of events the server should start.

limitinteger

Maximum number of results to be fetched for the query.

Example request

{
  "listEventType": "UPCOMING",
  "filters": [
    {
      "eventStatusFilter": [
        "DRAFT"
      ]
    }
  ],
  "travelerFilters": [
    {
      "searchTerm": "name"
    }
  ],
  "listByTravelerEvents": true,
  "offset": 2,
  "limit": 2,
  "sortOptions": [
    {
      "sortOrder": "DESC"
    }
  ]
}

Response

OK