Docs
DevelopersReferenceExplore

API: Browse Explore

GET
/v1/explore

Itineraries shared to Explore. With no q, the ranked Explore feed; with q, a text search; with following=true (or filter=following), itineraries from people you follow. Needs a token, but no scope. The first request picks a random order and its nextCursor keeps it for the next pages.

AuthorizationBearer <token>

A Travelyfe access token.

In: header

Query Parameters

q?string

Search text.

filter?"following"

following for itineraries from people you follow.

Value in

  • "following"
following?"true"

true for itineraries from people you follow. Same as filter=following.

Value in

  • "true"
regions?string

Comma-separated region names to show, up to eight, such as Asia,Middle East. Letters and spaces only.

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/explore"
{  "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"}