Skip to main content
GET
/
v2
/
orgs
/
{orgId}
/
guide-search
cURL
curl --request GET \
  --url 'https://api.obvlo.com/v2/orgs/{orgId}/guide-search?key='
{
  "results": [
    {
      "contentType": "<string>",
      "description": "<string>",
      "featured": false,
      "geoLocation": [
        123
      ],
      "hostIds": [
        "<string>"
      ],
      "id": "<string>",
      "keywords": [
        "<string>"
      ],
      "languageCodes": [
        "<string>"
      ],
      "listingIds": [
        "<string>"
      ],
      "name": "<string>",
      "updatedAt": 123,
      "attribution": {},
      "centerLocation": {},
      "coverImage": {
        "attributions": [
          "<string>"
        ],
        "category": "<string>",
        "id": "<string>",
        "images": [
          {
            "size": "<string>",
            "url": "<string>"
          }
        ],
        "keywords": [
          "<string>"
        ],
        "isGenerated": true,
        "genDescription": "<string>",
        "license": "<string>",
        "isLicensed": true
      },
      "introText": "<string>",
      "preferences": {
        "timeOfDay": [
          "<string>"
        ],
        "timeOfYear": [
          "<string>"
        ],
        "tripType": [
          "<string>"
        ],
        "userCategories": [
          "<string>"
        ],
        "userInterests": [
          "<string>"
        ],
        "weatherType": [
          "<string>"
        ]
      },
      "priority": 1,
      "status": "<string>",
      "geoDistance": 123,
      "listings": [
        {
          "address": "<string>",
          "contentType": "<string>",
          "featured": true,
          "geoLocation": [
            123
          ],
          "guideIds": [
            "<string>"
          ],
          "hostIds": [
            "<string>"
          ],
          "id": "<string>",
          "name": "<string>",
          "photos": [
            {
              "attributions": [
                "<string>"
              ],
              "category": "<string>",
              "id": "<string>",
              "images": [
                {
                  "size": "<string>",
                  "url": "<string>"
                }
              ],
              "keywords": [
                "<string>"
              ],
              "isGenerated": true,
              "genDescription": "<string>",
              "license": "<string>",
              "isLicensed": true
            }
          ],
          "score": 123,
          "searchId": "<string>",
          "status": "<string>",
          "summary": "<string>",
          "activityTags": [
            "<string>"
          ],
          "additionalTextAttributes": {
            "photos": "<string>",
            "duration": "<string>",
            "bestTimeToVisit": "<string>",
            "crowdLevels": "<string>",
            "gettingThere": "<string>"
          },
          "category": "<string>",
          "currencyCode": "<string>",
          "deliveryApps": [
            {
              "url": "<string>",
              "type": "<string>"
            }
          ],
          "embeds": [
            {
              "code": "<string>",
              "type": "<string>",
              "provider": "<string>"
            }
          ],
          "googleId": "<string>",
          "googleMapsUrl": "<string>",
          "googleRating": 123,
          "integratedCategories": [
            {
              "category_id": "<string>",
              "full_label": [
                "<string>"
              ]
            }
          ],
          "keywords": [
            "<string>"
          ],
          "languageCodes": [
            "<string>"
          ],
          "neighborhood": "<string>",
          "openingHours": {
            "isUnavailable": true,
            "nextCloseTime": "<string>",
            "openNow": true,
            "weekday_text": [
              "<string>"
            ],
            "periods": [
              {
                "open": {
                  "day": 123,
                  "time": "<string>",
                  "hours": 123,
                  "minutes": 123,
                  "hour": 123,
                  "minute": 123
                },
                "close": {
                  "day": 123,
                  "time": "<string>",
                  "hours": 123,
                  "minutes": 123,
                  "hour": 123,
                  "minute": 123
                }
              }
            ]
          },
          "phoneNumber": "<string>",
          "planVisit": "<string>",
          "preferences": {
            "timeOfDay": [
              "<string>"
            ],
            "timeOfYear": [
              "<string>"
            ],
            "tripType": [
              "<string>"
            ],
            "userCategories": [
              "<string>"
            ],
            "userInterests": [
              "<string>"
            ],
            "weatherType": [
              "<string>"
            ]
          },
          "priceLevel": 123,
          "priceLevelText": "<string>",
          "priority": 123,
          "searchTerms": [
            "<string>"
          ],
          "serviceTypes": [
            "<string>"
          ],
          "socialMedia": [
            {
              "name": "<string>",
              "url": "<string>",
              "icon": "<string>",
              "target": "<string>"
            }
          ],
          "tableBooking": {
            "url": "<string>",
            "type": "<string>"
          },
          "tagline": "<string>",
          "tripAdvisorRating": 123,
          "tripAdvisorUrl": "<string>",
          "websiteUrl": "<string>",
          "whatToExpect": "<string>",
          "geoDistance": 123,
          "additionalData": {
            "dateTimestamp": 123,
            "date": {
              "start_date": "<string>",
              "when": "<string>"
            },
            "venue": {
              "link": "<string>",
              "name": "<string>",
              "reviews": 123
            },
            "ticket_info": [
              {
                "link": "<string>",
                "link_type": "<string>",
                "source": "<string>"
              }
            ]
          }
        }
      ]
    }
  ],
  "total": 123,
  "pages": 123
}

Authorizations

​
key
string
query
required

Path Parameters

​
orgId
string
required

Organization Account Number

Query Parameters

​
profileId
string

Unique profile identifier

​
searchQuery
string

A text query containing a name and optionally a location

​
page
string

Page index used to get next page of responses

​
hitsPerPage
string

Hits per page, maximum 20

​
latlng
string

Latitude and Longitude as the center of search, comma separated. Ex: 55.953251,-3.188267

​
radius
string

Radius in meters from center of search

​
userCategory
string

Adding a user category will only return guides that match the category. Possible values: business, family, friends, solo, or couples

​
tripType
string

Adding a trip type will rank guides based on trip type suitability. Possible values: business, pleasure, or both. Default: both

​
userInterests
string

Comma-separated list of user interests to rank results by weighted match. Available values can be retrieved from the /getPersonalizationOptions endpoint.

​
includeListings
string

Whether to include listings in the guide response

​
maxListingsPerGuide
string

Maximum number of listings to include per guide

​
rankBy
string

Ranking strategy. One of: 'distance', 'relevance', 'score'

​
lang
string

BCP-47 language code (e.g. en-GB). When provided, localizable fields are returned as a single string instead of a language map.

Response

Success

​
results
object[]
required
​
total
number
required
​
pages
number
required