Sign in

v1

latestOpenAPI 3.1.02026-08-0624411242.2 KB
Events

Get travelers list

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

post/v2/events/{eventId}/travelers-list

Request body

offsetinteger

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

limitinteger

Maximum number of results to be fetched for the query.

type'GENERIC' | 'PROGRAM' | 'PROGRAM_SESSION' | 'PROGRAM_TRIP'

Type of an event

Example request

{
  "offset": 2,
  "limit": 2,
  "type": "GENERIC",
  "filters": [
    {
      "searchTerm": "name"
    }
  ]
}

Response

OK

Example response

{
  "travelerEventInfos": [
    {
      "tripInfos": [
        {
          "tripId": "1234567890",
          "status": "PENDING_STATUS"
        }
      ],
      "eventRsvpResponse": {
        "air": {
          "notNeeded": true
        },
        "hotel": {
          "notNeeded": true
        },
        "car": {
          "notNeeded": true
        },
        "rail": {
          "notNeeded": true
        }
      },
      "eventUserRsvp": {
        "eventRsvpResponse": {
          "air": {
            "notNeeded": true
          },
          "hotel": {
            "notNeeded": true
          },
          "car": {
            "notNeeded": true
          },
          "rail": {
            "notNeeded": true
          }
        },
        "invitedAt": {
          "iso8601": "2017-07-21T17:32Z"
        },
        "airBookingStatus": "BOOKED",
        "railBookingStatus": "BOOKED",
        "carBookingStatus": "BOOKED",
        "hotelBookingStatus": "BOOKED"
      }
    }
  ],
  "userGroupInfo": {
    "userGroupCriteria": [
      {
        "legalEntityIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "officeIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "personas": [
          "EMPLOYEE"
        ],
        "countryCodes": [
          "GB"
        ],
        "workerTypes": [
          "EMPLOYEE"
        ]
      }
    ]
  }
}