# Get travelers list

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

Endpoint: POST /v2/events/{eventId}/travelers-list
Version: v2
Security: Bearer

## Path parameters:

  - `eventId` (string, required)
    Event ID
    Example: "6926658168"

## Request fields (application/json):

  - `offset` (integer)
    Indicates from where in the list of travelers the server should start.
    Example: 2

  - `limit` (integer)
    Maximum number of results to be fetched for the query.
    Example: 2

  - `type` (string)
    Type of an event
    Enum: "GENERIC", "PROGRAM", "PROGRAM_SESSION", "PROGRAM_TRIP"

  - `filters` (array)
    Filters for event travelers

## Response 200 fields (application/json):

  - `travelerEventInfos` (array)
    List of user rsvp responses & trip details

  - `travelerEventInfos.userId` (object)
    User Id

  - `travelerEventInfos.userId.id` (string, required)

  - `travelerEventInfos.tripInfos` (array)
    List of trip info for the user

  - `travelerEventInfos.tripInfos.tripId` (string, required)
    ID of the trip of the user.
    Example: "1234567890"

  - `travelerEventInfos.tripInfos.status` (string, required)
    User facing booking status
    Enum: "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"

  - `travelerEventInfos.eventUserRsvp` (object)
    User's rsvp information.

  - `travelerEventInfos.eventUserRsvp.userId` (object)
    User identifier

  - `travelerEventInfos.eventUserRsvp.eventRsvpState` (string)
    Allowed event rsvp states for a user
    Enum: "ADDED", "INVITED", "INVITE_ACCEPTED", "INVITE_DECLINED", "REMOVED"

  - `travelerEventInfos.eventUserRsvp.eventRsvpResponse` (object)
    Event rsvp response

  - `travelerEventInfos.eventUserRsvp.eventRsvpResponse.air` (object)
    Air rsvp response

  - `travelerEventInfos.eventUserRsvp.eventRsvpResponse.air.notNeeded` (boolean)
    Whether air booking is needed by the traveler or not
    Example: true

  - `travelerEventInfos.eventUserRsvp.eventRsvpResponse.hotel` (object)
    Hotel rsvp response

  - `travelerEventInfos.eventUserRsvp.eventRsvpResponse.hotel.notNeeded` (boolean)
    Whether hotel booking is needed by the traveler or not
    Example: true

  - `travelerEventInfos.eventUserRsvp.eventRsvpResponse.car` (object)
    Car rsvp response

  - `travelerEventInfos.eventUserRsvp.eventRsvpResponse.car.notNeeded` (boolean)
    Whether car booking is needed by the traveler or not
    Example: true

  - `travelerEventInfos.eventUserRsvp.eventRsvpResponse.rail` (object)
    Rail rsvp response

  - `travelerEventInfos.eventUserRsvp.eventRsvpResponse.rail.notNeeded` (boolean)
    Whether rail booking is needed by the traveler or not
    Example: true

  - `travelerEventInfos.eventUserRsvp.invitedAt` (object)
    ISO8601 UTC Date Time

  - `travelerEventInfos.eventUserRsvp.invitedAt.iso8601` (string, required)
    Example: "2017-07-21T17:32Z"

  - `travelerEventInfos.eventUserRsvp.airBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `travelerEventInfos.eventUserRsvp.railBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `travelerEventInfos.eventUserRsvp.carBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `travelerEventInfos.eventUserRsvp.hotelBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `travelerEventInfos.eventRsvpState` (string)
    Users' rsvp state
    Enum: "ADDED", "INVITED", "INVITE_ACCEPTED", "INVITE_DECLINED", "REMOVED"

  - `travelerEventInfos.eventRsvpResponse` (object)
    Users' rsvp response. This includes details related to bookings

  - `userGroupInfo` (object)
    Details about group's users

  - `userGroupInfo.userGroupCriteria` (array)
    User group criteria

  - `userGroupInfo.userGroupCriteria.userIds` (array)

  - `userGroupInfo.userGroupCriteria.legalEntityIds` (array)

  - `userGroupInfo.userGroupCriteria.officeIds` (array)

  - `userGroupInfo.userGroupCriteria.departments` (array)
    List of department ids.

  - `userGroupInfo.userGroupCriteria.costCenters` (array)
    List of cost center ids.

  - `userGroupInfo.userGroupCriteria.grades` (array)
    List of grade ids.

  - `userGroupInfo.userGroupCriteria.positionTitles` (array)

  - `userGroupInfo.userGroupCriteria.personas` (array)
    Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC"

  - `userGroupInfo.userGroupCriteria.countryCodes` (array)
    Example: ["GB"]

  - `userGroupInfo.userGroupCriteria.workerTypes` (array)
    Enum: "EMPLOYEE", "CONTINGENT", "SEASONAL", "INTERN", "GUEST"

  - `userGroupInfo.userGroupCriteria.accountingCodes` (array)

  - `userGroupInfo.userGroupCriteria.customFieldIds` (array)

  - `userGroupInfo.userGroupCriteria.customFieldIds.type` (string, required)
    The type of custom field.
    Enum: "QUESTION", "MEETING", "BUDGET", "BREX_TOKEN"

  - `userGroupInfo.userGroupCriteria.customFieldIds.externalId` (string, required)
    Meeting id or budget id based on custom field type.

  - `userGroupInfo.userIds` (array)
    List of users derived from the user group criteria

  - `paginationParams` (object)
    Total number of active travelers in the event

  - `paginationParams.totalNumResults` (integer, required)
    Total number of results.

## Response 400 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.