Skip to content
campaiDeveloper
campai.com

Crm · Social integrations

GET/{organizationId}/crm/communication/socialIntegrationsReads only

List social integrations

Lists configured providers and connected social accounts without exposing credentials, with whether their statistics are available or need a new connection, and when the platform data of an account not connected anymore is deleted.

Permissions

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

Permission checks in detail
Required permissions
  • social.read

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' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • integrationsobject[]
    4 properties
    • platformstring
      facebook linkedin tiktok instagram pinterest youtube bluesky threads wordpress googleMyBusiness
    • configuredboolean
    • providersobject[]
      3 properties
      • providerstring
        13 values
        facebook linkedin linkedinPage tiktok tiktokBusiness instagram instagramStandalone pinterest youtube bluesky threads wordpress googleMyBusiness
      • configuredboolean
      • authenticationstring
        oauth credentials
    • accountsobject[]
      10 properties
      • providerstring
        13 values
        facebook linkedin linkedinPage tiktok tiktokBusiness instagram instagramStandalone pinterest youtube bluesky threads wordpress googleMyBusiness
      • externalIdstring
      • namestring
      • usernamestringnullable
      • urlstringnullable
      • statusstring
        connected disconnected reconnectRequired
      • statisticsStatusstringnullable
        available missingPermission
      • dataDeletionDueAtstring · date-timenullable
      • idid
      • scheduledPostsinteger

        at least 0

Response200
{
  "integrations": [
    {
      "platform": "facebook",
      "configured": true,
      "providers": [
        {
          "provider": "facebook",
          "configured": true,
          "authentication": "oauth"
        }
      ],
      "accounts": [
        {
          "provider": "facebook",
          "externalId": "string",
          "name": "string",
          "username": "string",
          "url": "string",
          "status": "connected",
          "statisticsStatus": "available",
          "dataDeletionDueAt": "2026-06-15T22:30:00Z",
          "id": "000000000000000000000001",
          "scheduledPosts": 0
        }
      ]
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.