Skip to content
campaiDeveloper
campai.com

Crm · Social posts

GET/{organizationId}/crm/communication/socialPosts/overviewReads only

Get social publishing overview

Returns a social publishing overview for the given organizationId. It includes counts of scheduled posts, posts needing attention, and published deliveries in the last 30 UTC days, plus up to five upcoming, attention, and recent posts per section.

Permissions

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

Who may call it

  • Requires organization access with 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/socialPosts/overview' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • publishedinteger

    at least 0

  • scheduledinteger

    at least 0

  • problemsinteger

    at least 0

  • postsobject[]
    8 properties
    • statusstring
      scheduled pending publishing processing published partiallyPublished failed unconfirmed
    • scheduledAtstring · date-timenullable
    • publicationDatestring · date-time
    • postIdid
    • textstring
    • mediaCountinteger

      at least 0

    • deliveriesobject[]
      9 properties
      • statusstring
        pending publishing processing published failed unconfirmed
      • urlstringnullable
      • errorDetailsobjectnullable
        6 properties
        • categorystring
          authentication permission validation rateLimit temporary unknown
        • actionstring
          reconnect reviewPermissions editPost retryLater checkPlatform contactSupport
        • codestringnullable
        • reasonstringnullable
          26 values
          apiQuota youtubeUploadLimit videoDuration mediaFormat invalidMedia videoFrameRate mediaDimensions mediaDownload uploadAborted mediaDomain privacySetting postingLimit accountRestricted duplicateVideo contentRights contentPolicy verifyEmail mediaType emptyPost unconfirmed platformRejected wordpressNotPublished containerFailed youtubeFailed facebookFailed tiktokFailed
        • stagestring
          preflight upload publish poll
        • occurredAtstring · date-time
      • publishedAtstring · date-timenullable
      • accountIdid
      • canRetryboolean
      • canCheckboolean
      • canRepublishboolean
      • canDismissboolean
    • sectionstring
      upcoming attention recent
Response200
{
  "published": 0,
  "scheduled": 0,
  "problems": 0,
  "posts": [
    {
      "status": "scheduled",
      "scheduledAt": "2026-06-15T22:30:00Z",
      "publicationDate": "2026-06-15T22:30:00Z",
      "postId": "000000000000000000000001",
      "text": "string",
      "mediaCount": 0,
      "deliveries": [
        {
          "status": "pending",
          "url": "string",
          "errorDetails": {
            "category": "authentication",
            "action": "reconnect",
            "code": "string",
            "reason": "apiQuota",
            "stage": "preflight",
            "occurredAt": "2026-06-15T22:30:00Z"
          },
          "publishedAt": "2026-06-15T22:30:00Z",
          "accountId": "000000000000000000000001",
          "canRetry": true,
          "canCheck": true,
          "canRepublish": true,
          "canDismiss": true
        }
      ],
      "section": "upcoming"
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.