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
| Name | Type | Required | Description |
|---|---|---|---|
publisher | string | optional | Type of connected accounts to filter by. Accepted values
|
status | string | optional | Connection status to filter by.
|
page | integer | optional | Page number for pagination |
perPage | integer | optional | Number 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'const res = await fetch('https://api.synup.com/api/v4/connected-accounts?publisher=&status=&page=&perPage=', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/connected-accounts?publisher=&status=&page=&perPage=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/connected-accounts?publisher=&status=&page=&perPage=", nil)
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 connected accounts |
401 | Unauthorized - Invalid or missing API key |
403 | Forbidden - 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
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.connectedAccountsInfo | object | optional | |
data.connectedAccountsInfo.pageInfo | object | optional | |
data.connectedAccountsInfo.pageInfo.hasNextPage | boolean | optional | Indicates if there are more pages available |
data.connectedAccountsInfo.pageInfo.hasPreviousPage | boolean | optional | Indicates if there are previous pages available |
data.connectedAccountsInfo.pageInfo.totalPages | integer | optional | Total number of pages available |
data.connectedAccountsInfo.pageInfo.totalRecords | integer | optional | Total number of records across all pages |
data.connectedAccountsInfo.records | array of object | optional | |
data.connectedAccountsInfo.records[].connectedAccountId | string | optional | Unique identifier of the connected account |
data.connectedAccountsInfo.records[].connectedAccountType | string | optional | Type of the connected accountGoogleAccountFacebookAccount |
data.connectedAccountsInfo.records[].connectedLocationsCount | integer | optional | Number of locations connected with this account |
data.connectedAccountsInfo.records[].connectivityIssue | string | optional | Type of connectivity issue if any:
|
data.connectedAccountsInfo.records[].email | string | optional | Email address associated with the connected account |
data.connectedAccountsInfo.records[].lastFetchMatchesRequestedAt | string | optional | Timestamp of the last matches request |
data.connectedAccountsInfo.records[].requestMatches | boolean | optional | Indicates if the account can trigger matches |
data.connectedAccountsInfo.records[].requestMatchesStatus | string | optional | Status of the last request matches triggered |
data.connectedAccountsInfo.records[].status | string | optional | Current connection statusCONNECTEDConnectionIssue |
data.connectedAccountsInfo.records[].remarks | string | optional | Additional information about account status or errors |