Suggest Locations

Returns address suggestions for the given search term.

By default this uses the map engine autosuggest. Pass one of the mode flags to change the lookup:

  • cities — city name suggestions
  • zipcode — zip code lookup
  • geocode — geocode the term as a full address

Query Sample

GET /api/open/maps/suggest?tenant=demo&term=400%20w%20e%20indiana
GET /api/open/maps/suggest?tenant=demo&term=Dan%20P&cities=true
GET /api/open/maps/suggest?tenant=demo&term=90242&zipcode=true
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Tenant name (e.g. demo).

string
required

Search term for address, city, or zip code suggestions.

boolean

When present, return city name suggestions instead of address autosuggest.

boolean

When present, look up locations by zip code.

boolean

When present, geocode the term as a full address instead of using autosuggest.

string
enum

Map engine to use. Supported values: Here, Google. Defaults to the tenant or system map engine.

Allowed:
Responses

401

Invalid authentication token

403

Not authorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json