Trips

List a trip's travellers

GET/api/v1/trips/{id}/travelersScope contacts:read

Who travels, in the order of the trip's roster, each linked to their contact when they have one. Returned whole, never paged. Empty when the agency recorded the group as head counts only.

Path parameters

idstring

Query parameters

No parameters.

Returns

A list of Traveler objects.

object"list"

dataarray of Traveler

next_cursorundefined

Errors

401unauthorizedNo key, a malformed one, or a key that does not exist or was revoked. Send it as Authorization: Bearer <key>.

403api_not_enabledRoundPlan has not turned on API access for this agency.

403subscription_inactiveThe agency's trial expired or its subscription ended.

403insufficient_scopeThe key cannot read this. An owner adds contacts:read to a key in Settings → API.

404not_foundNothing with that id in this agency.

429rate_limitedToo many requests. Wait the seconds in Retry-After. See Errors and rate limits.

500internal_errorSomething went wrong on our side. Retry later.

{ "object": "list", "data": [ { "object": "traveler", "id": "t-3e97d0", "name": "Rob Shultz", "golfer": true, "primary": true, "email": "rob@example.com", "phone": "+1 613 555 0142", "country": "CA", "contact_id": "91f0b3a6-4d27-4c58-a1e9-3f6b2d8c7e05" }, { "object": "traveler", "id": "t-8b41c2", "name": "Carla Puig", "golfer": true, "primary": false, "email": "carla@example.com", "phone": null, "country": "ES", "contact_id": "2c9d4b71-5e3a-4f06-8d12-9b7a6e5c4d38" } ], "next_cursor": null }