Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/connected-accounts/{connectedAccountId}/connection-suggestions

List Connection Suggestions

This API retrieves all connection suggestions for a connected account. These suggestions represent potential matches between locations in your account and business profiles on Google My Business or Facebook Pages.

Behavior:

  • Identifies locations in your account that closely match profiles on Google or Facebook.
  • Uses criteria like business name, address, and phone number to generate suggestions.
  • Helps streamline the linking process between your locations and external listings.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Path

NameTypeRequiredDescription
connectedAccountIdstringrequiredID of the connected account

Query

NameTypeRequiredDescription
pageintegeroptionalPage number for pagination. Defaults to 1.
perPageintegeroptionalNumber of records per page. Defaults to 20.

Headers

NameTypeRequiredDescription
Content-Typestringrequired

Request

Request
curl -X GET 'https://api.synup.com/api/v4/connected-accounts/:connectedAccountId/connection-suggestions?page=&perPage=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200Successfully retrieved connection suggestions
Example response
{
  "data": {
    "connectionSuggestionsForAccount": {
      "pageInfo": {
        "hasNextPage": false,
        "hasPreviousPage": false,
        "totalPages": 1,
        "totalRecords": 2
      },
      "records": [
        {
          "accountEmail": "abc@synup.com",
          "accountType": "GMB",
          "connectedAccountId": "bc818dc7-1576-4e50-a69d-c69d22103588",
          "locationId": "73415",
          "locationInfo": {
            "city": "Lincoln",
            "countryIso": "US",
            "countryName": "United States",
            "name": "Stg - 24 Aug - with Store code",
            "phone": "3125270491",
            "postalCode": "68502",
            "stateIso": "NE",
            "stateName": "Nebraska",
            "storeCode": "update store code and address 123",
            "street": "3201 South St, 17 cross#778",
            "street1": null
          },
          "matchedDataDatabaseId": "0d5e306f-0da0-46e3-929f-fd3c67ccd8cc",
          "suggestedLocationInfo": {
            "liveLink": null,
            "locationInfo": {
              "city": "Lincoln",
              "country": "US",
              "name": "Stg - 24 Aug - with Store code",
              "phone": "(312) 527-0491",
              "postalCode": "68502",
              "state": "NE",
              "street": "3201 South St, 17 cross, #778"
            },
            "mainAccount": "Business 1",
            "mainAccountId": null,
            "storeCode": null,
            "subAccount": null,
            "ownerRole": "PRIMARY_OWNER"
          }
        }
      ]
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.connectionSuggestionsForAccountobjectoptional
data.connectionSuggestionsForAccount.pageInfoobjectoptional
data.connectionSuggestionsForAccount.pageInfo.hasNextPagebooleanoptionalIndicates if there are more pages available
data.connectionSuggestionsForAccount.pageInfo.hasPreviousPagebooleanoptionalIndicates if there are previous pages available
data.connectionSuggestionsForAccount.pageInfo.totalPagesintegeroptionalTotal number of pages available
data.connectionSuggestionsForAccount.pageInfo.totalRecordsintegeroptionalTotal number of records across all pages
data.connectionSuggestionsForAccount.recordsarray of objectoptional
data.connectionSuggestionsForAccount.records[].accountEmailstringoptionalEmail of the user for the connected account
data.connectionSuggestionsForAccount.records[].accountTypestringoptionalType of the connected account (GMB for Google My Business, FB for Facebook)
GMBFB
data.connectionSuggestionsForAccount.records[].connectedAccountIdstringoptionalID of the connected account
data.connectionSuggestionsForAccount.records[].locationIdstringoptionalID of the location
data.connectionSuggestionsForAccount.records[].locationInfoobjectoptional
data.connectionSuggestionsForAccount.records[].locationInfo.approvedbooleanoptionalWhether the location is approved
data.connectionSuggestionsForAccount.records[].locationInfo.namestringoptionalLocation name
data.connectionSuggestionsForAccount.records[].locationInfo.streetstringoptionalStreet address line 1
data.connectionSuggestionsForAccount.records[].locationInfo.street1stringoptionalStreet address line 2
data.connectionSuggestionsForAccount.records[].locationInfo.citystringoptionalCity
data.connectionSuggestionsForAccount.records[].locationInfo.postalCodestringoptionalPostal / ZIP code
data.connectionSuggestionsForAccount.records[].locationInfo.countryIsostringoptionalISO country code (e.g. IN, US)
data.connectionSuggestionsForAccount.records[].locationInfo.storeCodestringoptionalStore code of the location, if set
data.connectionSuggestionsForAccount.records[].locationInfo.liveLinkstringoptionalPublic live link of the location's listing on the source
data.connectionSuggestionsForAccount.records[].matchedDataDatabaseIdstringoptionalID of the suggestion record, used for confirming the match
data.connectionSuggestionsForAccount.records[].suggestedLocationInfoobjectoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.liveLinkstringoptionalLive link to the location profile
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfoobjectoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.citystringoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.countrystringoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.namestringoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.phonestringoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.postalCodestringoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.statestringoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.streetstringoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.mainAccountstringoptionalName of the main account
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.mainAccountIdstringoptionalID of the main account
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.storeCodestringoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.subAccountstringoptional
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.ownerRolestringoptionalGBP role of the connecting/importing user on this listing (e.g. PRIMARY_OWNER, OWNER, MANAGER, SITE_MANAGER). Google (GMB) only; null when Google exposes no matching admin or for non-Google listings.