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
| Name | Type | Required | Description |
|---|---|---|---|
connectedAccountId | string | required | ID of the connected account |
Query
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | optional | Page number for pagination. Defaults to 1. |
perPage | integer | optional | Number of records per page. Defaults to 20. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type | string | required |
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'const res = await fetch('https://api.synup.com/api/v4/connected-accounts/:connectedAccountId/connection-suggestions?page=&perPage=', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/connected-accounts/:connectedAccountId/connection-suggestions?page=&perPage=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/connected-accounts/:connectedAccountId/connection-suggestions?page=&perPage=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successfully 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
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.connectionSuggestionsForAccount | object | optional | |
data.connectionSuggestionsForAccount.pageInfo | object | optional | |
data.connectionSuggestionsForAccount.pageInfo.hasNextPage | boolean | optional | Indicates if there are more pages available |
data.connectionSuggestionsForAccount.pageInfo.hasPreviousPage | boolean | optional | Indicates if there are previous pages available |
data.connectionSuggestionsForAccount.pageInfo.totalPages | integer | optional | Total number of pages available |
data.connectionSuggestionsForAccount.pageInfo.totalRecords | integer | optional | Total number of records across all pages |
data.connectionSuggestionsForAccount.records | array of object | optional | |
data.connectionSuggestionsForAccount.records[].accountEmail | string | optional | Email of the user for the connected account |
data.connectionSuggestionsForAccount.records[].accountType | string | optional | Type of the connected account (GMB for Google My Business, FB for Facebook)GMBFB |
data.connectionSuggestionsForAccount.records[].connectedAccountId | string | optional | ID of the connected account |
data.connectionSuggestionsForAccount.records[].locationId | string | optional | ID of the location |
data.connectionSuggestionsForAccount.records[].locationInfo | object | optional | |
data.connectionSuggestionsForAccount.records[].locationInfo.approved | boolean | optional | Whether the location is approved |
data.connectionSuggestionsForAccount.records[].locationInfo.name | string | optional | Location name |
data.connectionSuggestionsForAccount.records[].locationInfo.street | string | optional | Street address line 1 |
data.connectionSuggestionsForAccount.records[].locationInfo.street1 | string | optional | Street address line 2 |
data.connectionSuggestionsForAccount.records[].locationInfo.city | string | optional | City |
data.connectionSuggestionsForAccount.records[].locationInfo.postalCode | string | optional | Postal / ZIP code |
data.connectionSuggestionsForAccount.records[].locationInfo.countryIso | string | optional | ISO country code (e.g. IN, US) |
data.connectionSuggestionsForAccount.records[].locationInfo.storeCode | string | optional | Store code of the location, if set |
data.connectionSuggestionsForAccount.records[].locationInfo.liveLink | string | optional | Public live link of the location's listing on the source |
data.connectionSuggestionsForAccount.records[].matchedDataDatabaseId | string | optional | ID of the suggestion record, used for confirming the match |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo | object | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.liveLink | string | optional | Live link to the location profile |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo | object | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.city | string | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.country | string | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.name | string | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.phone | string | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.postalCode | string | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.state | string | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.locationInfo.street | string | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.mainAccount | string | optional | Name of the main account |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.mainAccountId | string | optional | ID of the main account |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.storeCode | string | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.subAccount | string | optional | |
data.connectionSuggestionsForAccount.records[].suggestedLocationInfo.ownerRole | string | optional | GBP 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. |