POSTapi.synup.com/api/v4/connected-accounts/connected-account-listings

Fetch Connected Account Listings

This API retrieves all listings accessible to a specific Google My Business or Facebook Page account.

Features:

Pagination support – Up to 500 records per page.
Filtering options – Search by:
Street address
Postal code
City
Phone number
Business name

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

Name	Type	Required	Description
`Content-Type`	string	required

Body

Name	Type	Required	Description
`connectedAccountId`	string	required	ID of the connected account to fetch listings for
`locationInfo`	string	optional	Optional filter string to search across location fields: Street address Postal code City Phone number Business name
`page`	integer	optional	Page number for pagination
`perPage`	integer	optional	Number of records per page (maximum 500)

Request

curl -X POST 'https://api.synup.com/api/v4/connected-accounts/connected-account-listings' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "connectedAccountId": "3db66afa-151d-4212-a8b7-949f9fe9aaf9"
}'

const res = await fetch('https://api.synup.com/api/v4/connected-accounts/connected-account-listings', {
  method: 'POST',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "connectedAccountId": "3db66afa-151d-4212-a8b7-949f9fe9aaf9"
  }),
});
const data = await res.json();

import requests
res = requests.post(
    "https://api.synup.com/api/v4/connected-accounts/connected-account-listings",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
      "connectedAccountId": "3db66afa-151d-4212-a8b7-949f9fe9aaf9"
    },
)
data = res.json()

req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/connected-accounts/connected-account-listings", bytes.NewBufferString(payload))
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 listings
`400`	Invalid request parameters
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - Insufficient permissions

Example response (generated from the schema)

{
  "data": {
    "connectedAccountListings": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "totalPages": 0,
        "totalRecords": 0
      },
      "records": [
        {
          "accountTypeName": "Google",
          "address": "string",
          "id": "string",
          "liveLink": "string",
          "locationName": "string",
          "phone": "string",
          "type": "string",
          "ownerRole": "string"
        }
      ]
    }
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.connectedAccountListings`	object	optional
`data.connectedAccountListings.pageInfo`	object	optional
`data.connectedAccountListings.pageInfo.hasNextPage`	boolean	optional	Indicates if there are more pages available
`data.connectedAccountListings.pageInfo.hasPreviousPage`	boolean	optional	Indicates if there are previous pages available
`data.connectedAccountListings.pageInfo.totalPages`	integer	optional	Total number of pages available
`data.connectedAccountListings.pageInfo.totalRecords`	integer	optional	Total number of records across all pages
`data.connectedAccountListings.records`	array of object	optional
`data.connectedAccountListings.records[].accountTypeName`	string	optional	Publisher type of the listing `GoogleFacebook`
`data.connectedAccountListings.records[].address`	string	optional	Full address of the location
`data.connectedAccountListings.records[].id`	string	optional	Reference Listing ID that can be used to connect a location
`data.connectedAccountListings.records[].liveLink`	string	optional	Live link provided by Google/Facebook if available
`data.connectedAccountListings.records[].locationName`	string	optional	Name of the location
`data.connectedAccountListings.records[].phone`	string	optional	Phone number of the location
`data.connectedAccountListings.records[].type`	string	optional	Type of the listing if specified
`data.connectedAccountListings.records[].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.