Skip to main content
POST
/compass/locations/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
query
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
@type
string
default:CompassLocation
text
string | null
sub_text
string | null
category
string | null
seo_id
string | null
geo_id
string | null
source
integer | null
redirect_url
string | null
image
string | null