Docs
DevelopersReferenceItineraries

API: List Your Itineraries

GET
/v1/itineraries

Your own library: itineraries you made, ones shared with you, and ones you saved, liked or disliked.

AuthorizationBearer <token>

A Travelyfe access token.

In: header

Query Parameters

updatedSince?string

Only itineraries changed after this time.

Formatdate-time
filter?string

all (the default), owned, shared, saved, liked or disliked.

Value in

  • "all"
  • "owned"
  • "shared"
  • "saved"
  • "liked"
  • "disliked"
limit?integer

How many itineraries to return, 1 to 100. Defaults to 25.

Range1 <= value <= 100
Default25
cursor?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

curl -X GET "https://example.com/v1/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"}