Skip to content
campaiDeveloper
campai.com

Crm ยท Social integrations

GET/{organizationId}/crm/communication/socialIntegrations/summaryReads only

Get social integrations summary

Returns a social integrations summary for the specified organization. For every social platform, it reports whether the platform can be connected and the number of active and connected accounts. Accounts needing reconnection count as active but not connected.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • Requires organization access and the social.read permission.

Request

Path parameters

  • organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/communication/socialIntegrations/summary' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • platformsobject[]
    4 properties
    • platformstring
      facebook linkedin tiktok instagram pinterest youtube bluesky threads wordpress googleMyBusiness
    • configuredboolean
    • activeAccountsinteger

      at least 0

    • connectedAccountsinteger

      at least 0

Response200
{
  "platforms": [
    {
      "platform": "facebook",
      "configured": true,
      "activeAccounts": 0,
      "connectedAccounts": 0
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.