v1Resources/Connections/getList suggested connection matches

List suggested connection matches

Requires an active agency user. Writes require Settings access. User permissions and credential client restrictions both apply. Responses never include provider tokens.

get/api/v1/connections/suggestions
connections:read
Query parameters
platformstring (google | facebook)optional
Limit matches to Google or Facebook.
clientIdstringoptional
Filter by a client ID or public ID.
locationIdstringoptional
Filter by a location ID or public ID.
Response
dataobjectoptional
suggestionsarray of objectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The operation conflicts with the connection state, publisher set or content checks.
422The connection needs attention or the operation could not be completed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
502The publisher could not accept the selected fields.
503The connection needs attention or the operation could not be completed.
get/api/v1/connections/suggestions
Your API key
platform
clientId
locationId
{}

Guides that use this resource