---
title: "Get travelers list"
method: POST
path: "/v2/events/{eventId}/travelers-list"
tags: ["Events"]
---

# Get travelers list

`POST /v2/events/{eventId}/travelers-list`

## Request

- Base URL: `https://api-ext-sboxmeta.partners.spotnana.com`
- URL: `https://api-ext-sboxmeta.partners.spotnana.com/v2/events/{eventId}/travelers-list`
- Auth: HTTP bearer

Get a paginated list of travelers for an event, including each traveler's RSVP status, RSVP response, and `tripId`.

## Request body

- EventTravelersRequest: List of event travelers request
  - `offset` integer: Indicates from where in the list of travelers the server should start.
  - `limit` integer: Maximum number of results to be fetched for the query.
  - `type` 'GENERIC' | 'PROGRAM' | 'PROGRAM_SESSION' | 'PROGRAM_TRIP': Type of an event
  - `filters` EventTravelerFilter[]: Filters for event travelers
    - union: Event traveler filter
      - object: Traveler search filter
        - `type` string, required
        - `searchTerm` string
      - object: Invitation status filter
        - `type` string, required
        - `rsvpStates` EventRsvpState[], required: List of rsvp states for which travelers need to be fetched
      - object: Air Booking Status Filter
        - `type` string, required: Type of filter
        - `bookingStatus` BookingStatusType[], required: Air Booking status
      - object: Rail Booking Status Filter
        - `type` string, required: Type of filter
        - `bookingStatus` BookingStatusType[], required: Rail Booking status
      - object: Car Booking Status Filter
        - `type` string, required: Type of filter
        - `bookingStatus` BookingStatusType[], required: Car Booking status
      - object: Hotel Booking Status Filter
        - `type` string, required: Type of filter
        - `bookingStatus` BookingStatusType[], required: Hotel Booking status

## Response `200`

OK

- EventTravelersResponse: List of travelers response
  - `travelerEventInfos` TravelerEventInfo[]: List of user rsvp responses & trip details
    - `userId` UserId: User identifier
      - `id` string, uuid, required
    - `tripInfos` TripInfo[]: List of trip info for the user
      - `tripId` string, required: ID of the trip of the user.
      - `status` 'UNKNOWN_STATUS' | 'PENDING_STATUS' | 'CONFIRMED_STATUS' | 'ACTIVE_STATUS' | 'COMPLETED_STATUS' | 'CANCELLED_STATUS' | 'REFUNDED_STATUS' | 'VOIDED_STATUS' | 'PROCESSING_STATUS' | 'UNCONFIRMED_STATUS' | 'AIRLINE_CONTROL_STATUS' | 'PAYMENT_DECLINED_STATUS' | 'SCHEDULE_CHANGE_STATUS' | 'HOLD_STATUS' | 'APPROVAL_REQUESTED_STATUS' | 'APPROVAL_DENIED_STATUS' | 'CANCELLATION_IN_PROGRESS_STATUS' | 'INOPERATIVE_STATUS' | 'FLIGHT_UNCONFIRMED_STATUS', required: User facing booking status
    - `eventRsvpState` 'ADDED' | 'INVITED' | 'INVITE_ACCEPTED' | 'INVITE_DECLINED' | 'REMOVED': Allowed event rsvp states for a user
    - `eventRsvpResponse` EventRsvpResponse: Event rsvp response
      - `air` AirRsvpResponse: Air rsvp response
        - `notNeeded` boolean: Whether air booking is needed by the traveler or not
      - `hotel` HotelRsvpResponse: Hotel rsvp response
        - `notNeeded` boolean: Whether hotel booking is needed by the traveler or not
      - `car` CarRsvpResponse: Car rsvp response
        - `notNeeded` boolean: Whether car booking is needed by the traveler or not
      - `rail` RailRsvpResponse: Rail rsvp response
        - `notNeeded` boolean: Whether rail booking is needed by the traveler or not
    - `eventUserRsvp` EventUserRsvp: User rsvp for the event
      - `userId` UserId: User identifier
        - `id` string, uuid, required
      - `eventRsvpState` 'ADDED' | 'INVITED' | 'INVITE_ACCEPTED' | 'INVITE_DECLINED' | 'REMOVED': Allowed event rsvp states for a user
      - `eventRsvpResponse` EventRsvpResponse: Event rsvp response
        - `air` AirRsvpResponse: Air rsvp response
          - `notNeeded` boolean: Whether air booking is needed by the traveler or not
        - `hotel` HotelRsvpResponse: Hotel rsvp response
          - `notNeeded` boolean: Whether hotel booking is needed by the traveler or not
        - `car` CarRsvpResponse: Car rsvp response
          - `notNeeded` boolean: Whether car booking is needed by the traveler or not
        - `rail` RailRsvpResponse: Rail rsvp response
          - `notNeeded` boolean: Whether rail booking is needed by the traveler or not
      - `invitedAt` DateTimeOffset: ISO8601 UTC Date Time
        - `iso8601` string, required
      - `airBookingStatus` 'BOOKED' | 'NOT_BOOKED' | 'OPTED_OUT': Booking status of the travel.
      - `railBookingStatus` 'BOOKED' | 'NOT_BOOKED' | 'OPTED_OUT': Booking status of the travel.
      - `carBookingStatus` 'BOOKED' | 'NOT_BOOKED' | 'OPTED_OUT': Booking status of the travel.
      - `hotelBookingStatus` 'BOOKED' | 'NOT_BOOKED' | 'OPTED_OUT': Booking status of the travel.
  - `userGroupInfo` UserGroupInfo: Details about group's users.
    - `userGroupCriteria` UserGroup[]: User group criteria
      - `userIds` UserId[]
        - `id` string, uuid, required
      - `legalEntityIds` EntityId[]
        - `id` string, uuid, required
      - `officeIds` EntityId[]
        - `id` string, uuid, required
      - `departments` string[]: List of department ids.
      - `costCenters` string[]: List of cost center ids.
      - `grades` string[]: List of grade ids.
      - `positionTitles` string[]
      - `personas` Persona[]
      - `customFieldIds` CustomFieldId[]
        - `type` 'QUESTION' | 'MEETING' | 'BUDGET' | 'BREX_TOKEN', required: The type of custom field.
        - `externalId` string, required: Meeting id or budget id based on custom field type.
      - `countryCodes` string[]
      - `workerTypes` WorkerType[]
      - `accountingCodes` string[]
    - `userIds` UserId[]: List of users derived from the user group criteria
      - `id` string, uuid, required
  - `paginationParams` OffsetBasedPaginationResponseParams: Pagination parameters for response.
    - `totalNumResults` integer, required: Total number of results.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/spotnana/apis/event-api.md) - [All operations](https://skmtc.dev/spotnana/apis/event-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spotnana/apis/event-api/revisions/9c2bb29e7df1?raw)