Skip to main content
GET
Autocomplete Locations
Provides autocomplete suggestions for location-based filters used in lead and company search. This endpoint powers the autocomplete functionality in location filter dropdowns, helping users discover valid geographic locations including cities, states, and countries.

Authentication

This endpoint requires authentication. The user must be signed in to access autocomplete data.
This endpoint proxies requests to the locations search API. Results are cached for 7 days to improve performance.

Request

Search query to filter locations. Returns locations that match this text (city name, country name, or raw address).
integer
default:"25"
Number of results to return per page.
integer
default:"0"
Zero-based page number for pagination.

Response

Returns a paginated list of location items matching the search criteria.
LocationItem[]
Array of location items matching the query.
integer
Total number of matching locations across all pages.
integer
Total number of pages available.
integer
Number of items per page.
integer
Current page number (zero-based).
boolean
Whether this is the first page.
boolean
Whether this is the last page.
boolean
Whether the result set is empty.
integer
Number of elements in the current page.

Response Examples

Usage Examples

Search for cities starting with “San”

Search for locations in Germany

Paginate through results

Get default locations (no search filter)

Notes

  • Results are cached for 7 days to improve performance. The cache is shared across all users.
  • Use the search parameter for type-ahead/autocomplete functionality - it filters results that match the search text against city names, country names, and raw addresses.
  • The position field contains geographic coordinates that can be used for map displays or distance calculations.
  • All parameters are optional. If no search is provided, the endpoint returns a default set of popular locations.