Skip to main content
GET
/
v2
/
orgs
/
{orgId}
/
location-search
cURL
curl --request GET \
  --url 'https://api.obvlo.com/v2/orgs/{orgId}/location-search?key='
{
  "results": [
    {
      "id": "<string>",
      "hostIds": [
        "<string>"
      ],
      "status": "<string>",
      "geoLocation": [
        123
      ],
      "address": "<string>",
      "displayName": "<string>",
      "area": "<string>",
      "headline": "<string>",
      "description": "<string>",
      "keywords": [
        "<string>"
      ],
      "photos": [
        {
          "attributions": [
            "<string>"
          ],
          "category": "<string>",
          "id": "<string>",
          "images": [
            {
              "size": "<string>",
              "url": "<string>"
            }
          ],
          "keywords": [
            "<string>"
          ],
          "isGenerated": true,
          "genDescription": "<string>",
          "license": "<string>",
          "isLicensed": true
        }
      ],
      "radius": 123,
      "languageCodes": [
        "<string>"
      ],
      "geoDistance": 123
    }
  ],
  "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

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