Skip to main content
POST
social.connect.googlebusiness.locations.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
flow
string
required

The flow value the connect redirect carried, sealed for this connection: it carries what the sign-in captured for the location choice.

Required string length: 1 - 16384

Free-text search on the business name, applied by the platform: use it when the account owns many locations.

Required string length: 1 - 256
filter
string

A raw platform filter expression (advanced; wins over search), e.g. storeCode="LH279411".

Required string length: 1 - 1024

Response

The result

locations
object[]
required

The locations the sign-in can connect.

hasMore
boolean

True when more locations exist than were returned: narrow with search.