Skip to main content
GET
cURL

Authorizations

key
string
query
required

Path Parameters

orgId
string
required

Organization Account Number

Query Parameters

profileId
string

Unique profile identifier

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.

page
integer

Page index used to get next page of responses

hitsPerPage
integer

Hits per page, maximum 20

searchQuery
string

A text query containing a name and optionally a location

radius
number

Radius in meters from center of search

latlng
string

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

rankBy
string

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

activityTags
string

Comma-separated list of activity tags to filter listings

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