Skip to main content
GET
Get address suggestions
Use this endpoint to power address autocomplete when entering a trip’s start and end addresses. Generate an opaque session_token (for example a UUID) when the user begins typing in an address field, reuse it for every suggestion request in that session and the final address details request, then discard it. Requests sharing a token are grouped into a single billed session. Pass the selected suggestion’s place_id to the address details endpoint to fetch the formatted address and coordinates, and to create trip or update trip as google_start_place_id / google_end_place_id to have the trip’s distance computed automatically.

Authorizations

Authorization
string
header
required

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

Path Parameters

businessId
string<uuid>
required

The UUID of the business.

Query Parameters

query
string
required

The partial address text to get suggestions for.

session_token
string
required

An opaque session token generated by the client (e.g. a UUID). Use the same token for all autocomplete requests in one address-entry session and the final address details request, then discard it. Groups the requests into a single billed session.

Response

200 - application/json

Address suggestions retrieved successfully.

data
object[]
required