---
title: "List Connection Suggestions"
method: GET
path: "/connected-accounts/{connectedAccountId}/connection-suggestions"
tags: ["Connected Accounts"]
---

# List Connection Suggestions

`GET /connected-accounts/{connectedAccountId}/connection-suggestions`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/connected-accounts/{connectedAccountId}/connection-suggestions`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/connected-accounts/:connectedAccountId/connection-suggestions/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `connectedAccountId` string, uuid, required

## Query parameters

- `page` integer
- `perPage` integer

## Headers

- `Authorization` string, required
- `Content-Type` string, required

## Response `200`

Successfully retrieved connection suggestions

- ConnectionSuggestionsResponseV2
  - `data` object
    - `connectionSuggestionsForAccount` object
      - `pageInfo` PageInfoV2
        - `hasNextPage` boolean: Indicates if there are more pages available
        - `hasPreviousPage` boolean: Indicates if there are previous pages available
        - `totalPages` integer: Total number of pages available
        - `totalRecords` integer: Total number of records across all pages
      - `records` ConnectionSuggestionV2[]
        - `accountEmail` string, email: Email of the user for the connected account
        - `accountType` 'GMB' | 'FB': Type of the connected account (GMB for Google My Business, FB for Facebook)
        - `connectedAccountId` string, uuid: ID of the connected account
        - `locationId` string: ID of the location
        - `locationInfo` LocationInfoV2
          - `approved` boolean: Whether the location is approved
          - `name` string: Location name
          - `street` string, nullable: Street address line 1
          - `street1` string, nullable: Street address line 2
          - `city` string, nullable: City
          - `postalCode` string, nullable: Postal / ZIP code
          - `countryIso` string, nullable: ISO country code (e.g. `IN`, `US`)
          - `storeCode` string, nullable: Store code of the location, if set
          - `liveLink` string, nullable: Public live link of the location's listing on the source
        - `matchedDataDatabaseId` string: ID of the suggestion record, used for confirming the match
        - `suggestedLocationInfo` SuggestedLocationInfoV2
          - `liveLink` string, nullable: Live link to the location profile
          - `locationInfo` object
            - `city` string
            - `country` string
            - `name` string
            - `phone` string
            - `postalCode` string
            - `state` string
            - `street` string
          - `mainAccount` string: Name of the main account
          - `mainAccountId` string, nullable: ID of the main account
          - `storeCode` string, nullable
          - `subAccount` string, nullable
          - `ownerRole` string, nullable: 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.

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)