Crm ยท Social integrations
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.readpermission.
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'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/communication/socialIntegrations/summary", {
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/summary', 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
-
platformsobject[]4 properties
-
platformstringfacebooklinkedintiktokinstagrampinterestyoutubeblueskythreadswordpressgoogleMyBusiness -
configuredboolean -
activeAccountsintegerat least 0
-
connectedAccountsintegerat 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.