---
title: "List location connections"
method: GET
path: "/location-connections"
tags: ["Connected Accounts"]
---

# List location connections

`GET /location-connections`

## Request

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

This API returns a paginated list of your locations paired with each publisher (source), along with whether that location is connected, not connected, or has a connection issue for that publisher. It is the direct API equivalent of the <strong>Location Connections</strong> page.

Features:
- Pagination support – retrieve results in batches for efficient processing.
- Filtering options – filter location connections by:
    - Source / publisher (`source`)
    - Location id (`locationId`)
    - Location name / address / phone (`locationName`)
    - Connection status (`status`)
- Sorting – order by location info, publisher account email, or publisher type.

## Query parameters

- `source` 'GoogleAccount' | 'FacebookAccount' | 'AppleAccount' | 'YelpAccount' | 'TripadvisorAccount'
- `locationId` string
- `locationName` string
- `status` 'Connected' | 'NotConnected' | 'ConnectionIssue'
- `sortField` 'location_info' | 'account_mail' | 'account_type'
- `sortOrder` 'Ascending' | 'Descending'
- `page` integer
- `perPage` integer

## Headers

- `Authorization` string, required

## Response `200`

Successfully retrieved location connections

- LocationConnectionsResponse
  - `data` object
    - `locationsConnectInfo` 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` LocationConnectInfoV2[]
        - `locationId` string: Base64-encoded location id (`Location:<id>`)
        - `accountId` string: Account id the location belongs to
        - `clientName` string, nullable: Client / sub-account name
        - `accountType` 'GoogleAccount' | 'FacebookAccount' | 'AppleAccount' | 'YelpAccount' | 'TripadvisorAccount': Source / publisher this record represents
        - `status` string: Raw connection status of the location for this source. Values include `CONNECTED`, `NOT_CONNECTED`, `CONNECTION_ISSUE`, `EXPIRED`, `RENEW`, `MISSING`, `SUSPENDED`, etc.
        - `connectedAccountId` string, nullable: Id of the connected account, when connected
        - `providerId` string, nullable: Provider-side id of the connected listing, when connected
        - `accountMail` string, nullable: Email of the connected (publisher) account, when connected
        - `publisherAccountName` string, nullable: Display name of the connected publisher account
        - `publisherAccountId` string, nullable: Id of the connected publisher account
        - `listingSiteId` integer, nullable: Site id of the connected listing
        - `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
        - `connectedListingInfo` union: Details of the connected listing on the source. `null` when the location is not connected. When present, its shape depends on the source.
          - GmbConnectedListingInfoV2: Connected listing details when the source is Google (GMB)
            - `name` string
            - `addressLines` string[]
            - `administrativeArea` string, nullable
            - `locality` string, nullable
            - `regionCode` string, nullable
            - `postalCode` string, nullable
            - `phone` string, nullable
            - `storeCode` string, nullable
            - `gmbAccountNumber` string, nullable
            - `gmbGroup` string, nullable
            - `suspended` boolean, nullable
            - `liveLink` string, nullable
          - FbConnectedListingInfoV2: Connected listing details when the source is Facebook
            - `name` string
            - `street` string, nullable
            - `city` string, nullable
            - `state` string, nullable
            - `zip` string, nullable
            - `country` string, nullable
            - `phone` string, nullable
            - `storeCode` string, nullable
            - `parentPageName` string, nullable
            - `liveLink` string, nullable
          - AppleConnectedListingInfoV2: Connected listing details when the source is Apple
            - `name` string
            - `street` string, nullable
            - `city` string, nullable
            - `state` string, nullable
            - `zip` string, nullable
            - `country` string, nullable
            - `phone` string, nullable
            - `storeCode` string, nullable
            - `liveLink` string, nullable

## Other responses

- `401`: Unauthorized - Invalid or missing API key
- `403`: Forbidden - Insufficient permissions

---

[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)