v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
Connect

List GBP locations

For headless flows. Returns the list of GBP locations the user can manage. Use pendingDataToken (from the OAuth callback redirect) to list locations without consuming the token, so it remains available for select-location. Use X-Connect-Token header if connecting via API key.

get/v1/connect/googlebusiness/locations

Query parameters

profileIdstring

Profile ID from your connection flow. Required for auth validation when provided.

pendingDataTokenstring

Token from the OAuth callback redirect. Preferred over tempToken because it preserves server-side token storage. One of pendingDataToken or tempToken is required.

tempTokenstring

Legacy. Direct Google access token. Use pendingDataToken instead when available.

searchstring

Free-text search on the business name, applied server-side by Google. Use this for accounts that own many locations (the response is bounded, see hasMore) so the user can find a specific location without loading the full list.

filterstring

Raw Google Business Information API filter expression (advanced; takes precedence over search). Supports fields such as title, storeCode, storefront_address.postal_code, labels and categories, e.g. storeCode="LH279411". See Google's "Work with location data" guide.

Response

List of Google Business locations available for connection

hasMoreboolean

True when more locations exist than were returned (the list is bounded). Prompt the user to narrow the result set with search.