Skip to content
SynupAPI
Get an API key
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

NameTypeRequiredDescription
connectedAccountIdstringrequiredUnique identifier of the connected account

Headers

NameTypeRequiredDescription
Content-Typestringrequired

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'

Responses

StatusDescription
200Successfully retrieved connected account details
401Unauthorized - Invalid API key
404Connected account not found
500Internal 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

NameTypeRequiredDescription
dataobjectoptional
data.connectedAccountDetailsobjectoptional
data.connectedAccountDetails.detailsobjectoptional
data.connectedAccountDetails.details.connectedAccountIdstringrequiredID of the connected account
data.connectedAccountDetails.details.connectedAccountTypestringrequiredType of the connected account
GoogleAccountFacebookAccount
data.connectedAccountDetails.details.connectedLocationsCountintegerrequiredNumber of locations connected with the account
data.connectedAccountDetails.details.connectivityIssuestringoptionalConnection error message if any
data.connectedAccountDetails.details.emailstringrequiredEmail of the user for the connected account
data.connectedAccountDetails.details.lastFetchMatchesRequestedAtstringoptionalTimestamp when the last matches requests were fetched
data.connectedAccountDetails.details.requestMatchesbooleanrequiredIndicates whether the connected account can trigger for matches
data.connectedAccountDetails.details.requestMatchesStatusstringoptionalStatus of the last request matches triggered
MATCH_COMPLETEDMATCH_IN_PROGRESSMATCH_FAILED
data.connectedAccountDetails.details.statusstringrequiredConnection status of the connected account
CONNECTEDDISCONNECTEDCONNECTION_ISSUE
data.connectedAccountDetails.details.remarksstringoptionalConnected Account Fetch Status Error