Locations

Search places

Finds up to 12 continents, countries, states or regions and cities whose name or code matches what the user typed, best match first: names that start with the text, then names with a word that starts with it, then names that contain it, the given country’s places first, then bigger places. Accents and case are ignored. Each place’s path is the value a campaign’s locations take.

GET
/locations

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

querystringrequired
countrystring

An ISO 3166-1 alpha-2 country code, such as US or DE, whose places rank first: usually the user's own country.

Pattern: ^[A-Z]{2}$

Response

application/json

Success

locationsobject[]required

Up to 12 places, best match first.