Get travelers list

Request

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

Security

Bearer

Path

eventIdstringrequired

Event ID

Example:6926658168

Bodyapplication/json

offsetinteger, >= 0

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

Default:0

Example:2

limitinteger, [ 0 .. 100 ]

Maximum number of results to be fetched for the query.

Default:10

Example:2

typestring(EventType)

Type of an event

Enum:"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"

Example:"GENERIC"

filtersArray of objects(EventTravelerFilter)

Filters for event travelers

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/6926658168/travelers-list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "offset": 2,
    "limit": 2,
    "type": "GENERIC",
    "filters": [
      {
        "type": "TRAVELER_SEARCH_FILTER",
        "searchTerm": "name"
      }
    ]
  }'

Responses

OK

Bodyapplication/json

travelerEventInfosArray of objects(TravelerEventInfo)

List of user rsvp responses & trip details

userGroupInfoobject(UserGroupInfo)

Details about group's users

paginationParamsobject(PaginationResponseParams)

Total number of active travelers in the event

Response

{
  "travelerEventInfos": [
    { … }
  ],
  "userGroupInfo": {
    "userGroupCriteria": [ … ],
    "userIds": [ … ]
  },
  "paginationParams": {
    "totalNumResults": 0
  }
}