Synupv1
Create a key
v1Resources/Posts/getGet a post

Get a post

Returns a single post, including its per-platform submission performance.

get/api/v1/posts/{id}
posts:read
Query parameters
idstringrequired
The post to look up.
Response
dataobjectoptional
Additional internal fields may be present but are not part of the stable contract — rely only on the fields documented here.
idstringoptional
Unique identifier for the post.
namestringoptional
Internal name/label for the post.
typestringoptional
Post type (duplicate of postType, kept for backward compatibility).
statusstring (draft | scheduled | active | error)optional
Lifecycle status of the post: draft, scheduled, active, or error.
postTypestring (announcement | event | offer)optional
Post type: announcement, event, or offer.
clientIdstringoptional
ID of the client this post belongs to.
locationIdstringoptional
ID of the location this post belongs to, or null for a brand-level post.
locationNamestringoptional
Display name of the post's location, or null.
clientNamestringoptional
Display name of the post's client, or null.
platformsarray of stringoptional
The platforms this post targets.
messageGooglestringoptional
Caption used for Google, or null.
messageFacebookstringoptional
Shared social caption used by every non-Google platform, or null.
ctaTypestringoptional
Call-to-action type, or null.
ctaUrlstringoptional
Call-to-action URL, or null.
ctaUrlFacebookstringoptional
Facebook-specific call-to-action URL, or null.
xThreadbooleanoptional
Whether X thread mode is enabled (bypasses the 280-character limit).
ctaJsonobjectoptional
Raw per-platform call-to-action and targeting settings.
mediaUrlsarray of objectoptional
Media attached to the post, one entry per platform attachment.
urlstringoptional
platformstringoptional
typestring (image | video)optional
eventTitlestringoptional
Event or offer title, or null.
eventStartAtstringoptional
Event or offer start time, as an ISO 8601 timestamp, or null.
eventEndAtstringoptional
Event or offer end time, as an ISO 8601 timestamp, or null.
offerTermsstringoptional
Offer terms, or null.
offerCouponCodestringoptional
Offer coupon code, or null.
offerRedeemUrlstringoptional
Offer redemption URL, or null.
scheduledForstringoptional
When the post is scheduled to publish, as an ISO 8601 timestamp, or null to publish immediately.
createdAtstringoptional
When the post was created, as an ISO 8601 timestamp.
performancearray of objectoptional
Per-platform submission performance for this post.
submissionIdstringoptional
Unique identifier for the platform submission.
connectionIdstringoptional
ID of the connection this submission was sent through.
sitestringoptional
The platform this submission targets.
viewsnumberoptional
Total view count, or null if not yet available.
clicksnumberoptional
Total click count, or null if not yet available.
reactionsnumberoptional
Total reaction count.
sharesnumberoptional
Total share count.
commentsnumberoptional
Total comment count.
statusstringoptional
Status of this platform submission: pending, active, error, or deleted.
platformPostIdstringoptional
The platform's own id for the published post, or null.
postLinkstringoptional
Public URL of the published post on this platform, or null.
reviewStatestringoptional
Google moderation state (processing, live, rejected), or null for other platforms.
errorMessagestringoptional
Error message if this submission failed, or null.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/posts/{id}
Your API key
id *
{
  "data": {
    "id": "cm_post_abc123",
    "name": "Fall Special Announcement",
    "type": "announcement",
    "status": "scheduled",
    "postType": "announcement",
    "clientId": "cm_client_1",
    "locationId": "cm_loc_1",
    "locationName": "Acme Dental — Downtown",
    "clientName": "Acme Dental",
    "platforms": [
      "google",
      "facebook"
    ],
    "messageGoogle": "Join us this weekend for our fall special — 20% off all services!",
    "messageFacebook": "Join us this weekend for our fall special — 20% off all services!",
    "ctaType": "learn_more",
    "ctaUrl": "https://acmedental.example.com/fall-special",
    "ctaUrlFacebook": null,
    "xThread": false,
    "ctaJson": {
      "ctaType": "learn_more",
      "ctaUrl": "https://acmedental.example.com/fall-special",
      "ctaUrlFacebook": null,
      "xThread": false
    },
    "mediaUrls": [
      {
        "url": "https://cdn.synup.com/uploads/a1/promo.jpg",
        "platform": "facebook",
        "type": "image"
      }
    ],
    "eventTitle": null,
    "eventStartAt": null,
    "eventEndAt": null,
    "offerTerms": null,
    "offerCouponCode": null,
    "offerRedeemUrl": null,
    "scheduledFor": "2026-02-10T15:00:00.000Z",
    "createdAt": "2026-01-20T09:12:00.000Z",
    "performance": [
      {
        "submissionId": "cm_sub_xyz789",
        "connectionId": "cm_conn_1",
        "site": "facebook",
        "views": 890,
        "clicks": null,
        "reactions": 42,
        "shares": 6,
        "comments": 9,
        "status": "active",
        "platformPostId": "1234567890",
        "postLink": "https://www.facebook.com/1234567890",
        "reviewState": null,
        "errorMessage": null
      }
    ]
  }
}