Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/connected-accounts

List all connected accounts

This API retrieves a paginated list of all connected accounts under your account, with support for filtering by publisher type and connection status.

Features:

  • Pagination support – Retrieve results in batches for efficient processing.
  • Filtering options – Filter connected accounts by:
  • Publisher type (Google My Business, Facebook, etc.)
  • Connection status (Active, Expired, Disconnected)
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Query

NameTypeRequiredDescription
publisherstringoptional

Type of connected accounts to filter by. Accepted values

  • FacebookAccount
  • GoogleAccount
statusstringoptional

Connection status to filter by.

  • Connected - Currently connected accounts
  • ConnectionIssue - Accounts with connection issues
pageintegeroptionalPage number for pagination
perPageintegeroptionalNumber of records per page

Request

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

Responses

StatusDescription
200Successfully retrieved connected accounts
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
Example response (generated from the schema)
{
  "data": {
    "connectedAccountsInfo": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "totalPages": 0,
        "totalRecords": 0
      },
      "records": [
        {
          "connectedAccountId": "string",
          "connectedAccountType": "GoogleAccount",
          "connectedLocationsCount": 0,
          "connectivityIssue": "string",
          "email": "name@example.com",
          "lastFetchMatchesRequestedAt": "2026-01-01T00:00:00Z",
          "requestMatches": true,
          "requestMatchesStatus": "string",
          "status": "CONNECTED",
          "remarks": "string"
        }
      ]
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.connectedAccountsInfoobjectoptional
data.connectedAccountsInfo.pageInfoobjectoptional
data.connectedAccountsInfo.pageInfo.hasNextPagebooleanoptionalIndicates if there are more pages available
data.connectedAccountsInfo.pageInfo.hasPreviousPagebooleanoptionalIndicates if there are previous pages available
data.connectedAccountsInfo.pageInfo.totalPagesintegeroptionalTotal number of pages available
data.connectedAccountsInfo.pageInfo.totalRecordsintegeroptionalTotal number of records across all pages
data.connectedAccountsInfo.recordsarray of objectoptional
data.connectedAccountsInfo.records[].connectedAccountIdstringoptionalUnique identifier of the connected account
data.connectedAccountsInfo.records[].connectedAccountTypestringoptionalType of the connected account
GoogleAccountFacebookAccount
data.connectedAccountsInfo.records[].connectedLocationsCountintegeroptionalNumber of locations connected with this account
data.connectedAccountsInfo.records[].connectivityIssuestringoptional

Type of connectivity issue if any:

  • CONNECTED_LOCATIONS_ISSUE - Connected to inaccessible listings
  • CREDENTIALS_INVALIDATED - Expired credentials
data.connectedAccountsInfo.records[].emailstringoptionalEmail address associated with the connected account
data.connectedAccountsInfo.records[].lastFetchMatchesRequestedAtstringoptionalTimestamp of the last matches request
data.connectedAccountsInfo.records[].requestMatchesbooleanoptionalIndicates if the account can trigger matches
data.connectedAccountsInfo.records[].requestMatchesStatusstringoptionalStatus of the last request matches triggered
data.connectedAccountsInfo.records[].statusstringoptionalCurrent connection status
CONNECTEDConnectionIssue
data.connectedAccountsInfo.records[].remarksstringoptionalAdditional information about account status or errors