Crm · Social integrations
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'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/communication/socialIntegrations", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/communication/socialIntegrations', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
integrationsobject[]4 properties
-
platformstringfacebooklinkedintiktokinstagrampinterestyoutubeblueskythreadswordpressgoogleMyBusiness -
configuredboolean -
providersobject[]3 properties
-
providerstring13 values
facebooklinkedinlinkedinPagetiktoktiktokBusinessinstagraminstagramStandalonepinterestyoutubeblueskythreadswordpressgoogleMyBusiness -
configuredboolean -
authenticationstringoauthcredentials
-
-
accountsobject[]10 properties
-
providerstring13 values
facebooklinkedinlinkedinPagetiktoktiktokBusinessinstagraminstagramStandalonepinterestyoutubeblueskythreadswordpressgoogleMyBusiness -
externalIdstring -
namestring -
usernamestringnullable -
urlstringnullable -
statusstringconnecteddisconnectedreconnectRequired -
statisticsStatusstringnullableavailablemissingPermission -
dataDeletionDueAtstring · date-timenullable -
idid -
scheduledPostsintegerat 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.