Synup
Create a key
v1Resources/Connections/getList connected accounts

List connected accounts

Returns your agency's connected publisher/social accounts (Google, Facebook, Instagram, LinkedIn, TikTok, and others), optionally filtered by client or platform.

get/api/v1/connections
connections:read
Query parameters
clientIdstringoptional
Restrict results to one client. When your key is scoped to specific clients, results are always pre-filtered to those clients even if this is omitted.
platformstringoptional
Restrict results to one platform, e.g. facebook, google.
credentialsValidbooleanoptional
Restrict to accounts whose stored credentials are (true) or aren't (false) currently valid.
fetchStatusstringoptional
Restrict to accounts with this fetch status.
cursorstringoptional
Pagination cursor from a previous response's nextCursor.
limitintegeroptional
Max accounts to return, 1–100. Defaults to 20.
Response
dataobjectoptional
accountsarray of objectoptional
The matching connected accounts.
idstringoptional
Unique identifier for the connected account.
platformstringoptional
The platform this account connects to, e.g. google, facebook, instagram.
displayNamestringoptional
Display name of the connected account.
providerAccountIdstringoptional
The platform's own identifier for this account.
credentialsValidbooleanoptional
Whether the stored credentials are currently valid.
fetchStatusstringoptional
Current fetch status for this account, e.g. idle, fetching.
fetchErrorstringoptional
The last fetch error message, or null.
errorTagstringoptional
A short machine-readable error code, or null.
gmbGroupIdsarray of stringoptional
Google Business Profile group ids associated with this account, if any.
expiresAtstringoptional
When this account's access token expires, as an ISO 8601 timestamp, or null.
dataAccessExpiresAtstringoptional
When Meta's data-access window for this account expires, as an ISO 8601 timestamp, or null.
channelstringoptional
The channel this connection was made through.
clientIdstringoptional
ID of the client this account belongs to, or null for an agency-wide connection.
synupLocationIdstringoptional
Legacy location identifier. Deprecated — prefer clientLocationId.
clientLocationIdstringoptional
ID of the location this account is bound to, or null. Prefer this over synupLocationId.
fetchedListingsCountnumberoptional
Number of listings this account has fetched.
lastFetchedAtstringoptional
When this account last completed a fetch, as an ISO 8601 timestamp, or null.
connectionStatusstring (CONNECTED | MISSING | RENEW | DISCONNECTED | SUSPENDED | SUGGESTED_MATCH)optional
Overall health of this connection: CONNECTED, MISSING, RENEW, DISCONNECTED, SUSPENDED, or SUGGESTED_MATCH.
createdAtstringoptional
When this account was connected, as an ISO 8601 timestamp.
updatedAtstringoptional
When this account was last updated, as an ISO 8601 timestamp.
nextCursorstringoptional
Pagination cursor for the next page, or null when there are no more results.
totalCountnumberoptional
Total number of accounts matching the request.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/connections
Your API key
clientId
platform
credentialsValid
fetchStatus
cursor
limit
{
  "data": {
    "accounts": [
      {
        "id": "conn_1",
        "platform": "google",
        "displayName": "Acme Dental — Google",
        "providerAccountId": "112233445566",
        "credentialsValid": true,
        "fetchStatus": "ok",
        "fetchError": null,
        "errorTag": null,
        "gmbGroupIds": [],
        "expiresAt": null,
        "dataAccessExpiresAt": "2026-05-01T00:00:00.000Z",
        "channel": "local",
        "clientId": "cli_123",
        "synupLocationId": null,
        "clientLocationId": "loc_456"
      }
    ],
    "nextCursor": null,
    "totalCount": 1
  }
}