DevelopersReferenceItineraries
API: List A Traveller's Itineraries
Another traveller's itineraries that you are allowed to see. Send filter=owned. Their saved, liked and disliked lists are theirs alone and answer forbidden.
AuthorizationBearer <token>
A Travelyfe access token.
In: header
Path Parameters
accountId*string
The traveller's account id (UUID).
Format
uuidQuery Parameters
filter?"owned"
Only owned (the default for another traveller is refused with anything else: forbidden).
Value in
- "owned"
limit?integer
How many itineraries to return, 1 to 100. Defaults to 25.
Range
1 <= value <= 100Default
25cursor?string
The nextCursor from the previous page. Never build one yourself.
Header Parameters
Travelyfe-Itinerary-Shape?"clean"
Send clean on every request that reads or writes an itinerary. It is the shape this reference documents.
Value in
- "clean"
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/itineraries"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "destination": { "name": "string", "address": "string", "coordinate": { "latitude": -90, "longitude": -180 }, "placeId": "string", "countryCode": "string", "timeZone": "string", "code": "string" }, "summary": "string", "coverImageUrl": "string", "startDate": "string", "tags": [ "string" ], "visibility": "private", "role": "owner", "daysCount": 0, "stopsCount": 0, "author": { "accountId": "string", "username": "string", "displayName": "string", "imageUrl": "string" }, "updatedAt": "2019-08-24T14:15:22Z", "etag": "string", "likesCount": 0, "publishedAt": "string" } ], "nextCursor": "string"}