List events

Request

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

Security

Bearer

Bodyapplication/json

listEventTypestring

Type of events

Enum:"UPCOMING""PAST_OR_COMPLETED""CANCELLED_EVENT"

Example:"UPCOMING"

filtersArray of objects(EventFilter)

List events filters

travelerFiltersArray of objects(EventTravelerFilter)

Filters for event travelers

listByTravelerEventsboolean

Whether listing travelers or events.

Default:false

Example:true

offsetinteger, >= 0

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

Default:0

Example:2

limitinteger, <= 100

Maximum number of results to be fetched for the query.

Default:10

Example:2

sortOptionsArray of objects(SearchEventSortOptions)

Sort options for the list events request.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "listEventType": "UPCOMING",
    "filters": [
      {
        "userFilter": {
          "userId": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        }
      }
    ],
    "travelerFilters": [
      {
        "type": "TRAVELER_SEARCH_FILTER",
        "searchTerm": "name"
      }
    ],
    "listByTravelerEvents": true,
    "offset": 2,
    "limit": 2,
    "sortOptions": [
      {
        "sortField": "START_DATE",
        "sortOrder": "DESC"
      }
    ]
  }'

Responses

OK

Bodyapplication/json

eventsArray of objects(Event)

List of events

paginationParamsobject(PaginationResponseParams)

Pagination parameters for response.

Response

{
  "events": [
    { … }
  ],
  "paginationParams": {
    "totalNumResults": 0
  }
}