GETapi.synup.com/api/v4/connected-accounts/{connectedAccountId}/details
Fetch Connected Account Details
This API retrieves detailed information about a specific connected account.
Behavior:
- Returns account details only if the account is currently connected.
- If the account has been disconnected, no data will be returned.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Path
| Name | Type | Required | Description |
|---|---|---|---|
connectedAccountId | string | required | Unique identifier of the connected account |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type | string | required |
Request
Request
curl -X GET 'https://api.synup.com/api/v4/connected-accounts/:connectedAccountId/details' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/connected-accounts/:connectedAccountId/details', {
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/:connectedAccountId/details",
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/:connectedAccountId/details", 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 account details |
401 | Unauthorized - Invalid API key |
404 | Connected account not found |
500 | Internal server error |
Example response (generated from the schema)
{
"data": {
"connectedAccountDetails": {
"details": {
"connectedAccountId": "00000000-0000-0000-0000-000000000000",
"connectedAccountType": "GoogleAccount",
"connectedLocationsCount": 0,
"connectivityIssue": "string",
"email": "name@example.com",
"lastFetchMatchesRequestedAt": "2026-01-01T00:00:00Z",
"requestMatches": true,
"requestMatchesStatus": "MATCH_COMPLETED",
"status": "CONNECTED",
"remarks": "string"
}
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.connectedAccountDetails | object | optional | |
data.connectedAccountDetails.details | object | optional | |
data.connectedAccountDetails.details.connectedAccountId | string | required | ID of the connected account |
data.connectedAccountDetails.details.connectedAccountType | string | required | Type of the connected accountGoogleAccountFacebookAccount |
data.connectedAccountDetails.details.connectedLocationsCount | integer | required | Number of locations connected with the account |
data.connectedAccountDetails.details.connectivityIssue | string | optional | Connection error message if any |
data.connectedAccountDetails.details.email | string | required | Email of the user for the connected account |
data.connectedAccountDetails.details.lastFetchMatchesRequestedAt | string | optional | Timestamp when the last matches requests were fetched |
data.connectedAccountDetails.details.requestMatches | boolean | required | Indicates whether the connected account can trigger for matches |
data.connectedAccountDetails.details.requestMatchesStatus | string | optional | Status of the last request matches triggeredMATCH_COMPLETEDMATCH_IN_PROGRESSMATCH_FAILED |
data.connectedAccountDetails.details.status | string | required | Connection status of the connected accountCONNECTEDDISCONNECTEDCONNECTION_ISSUE |
data.connectedAccountDetails.details.remarks | string | optional | Connected Account Fetch Status Error |