Synupv1
Create a key
v1Resources/Posts/getList posts

List posts

Returns posts for one location, most recently created first, with per-platform submission state and aggregate stats.

get/api/v1/posts
posts:read
Query parameters
locationIdstringrequired
The location to list posts for. Required.
platformstringoptional
Restrict results to posts submitted to this platform.
typestring (announcement | event | offer)optional
Restrict results to one post type.
statusstringoptional
Restrict results to one post status.
fromstringoptional
Only include posts created on or after this date.
tostringoptional
Only include posts created on or before this date.
searchstringoptional
Case-insensitive match against the post's name.
pageintegeroptional
Page number, starting at 1. Defaults to 1.
perPageintegeroptional
Results per page, up to 50. Defaults to 20.
Response
dataobjectoptional
rowsarray of objectoptional
The matching posts.
idstringoptional
Unique identifier for the post.
namestringoptional
Internal name/label for the post.
typestringoptional
Post type: announcement, event, or offer.
statusstringoptional
Lifecycle status of the post: draft, scheduled, active, or error.
postDatestringoptional
The post's scheduled or created date, as an ISO 8601 timestamp.
platformsarray of stringoptional
The platforms this post targets.
firstMediaUrlstringoptional
URL of the post's first media item, or null.
firstMediaTypestringoptional
Type of the post's first media item (image or video), or null.
submissionsarray of objectoptional
Per-platform submission state for this post.
platformstringoptional
The platform this row is for.
statusstringoptional
Status of this platform submission: pending, active, error, or deleted.
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.
messagePreviewstringoptional
First 140 characters of the post's caption, or null.
viewsnumberoptional
Total view count, or null if not yet available.
clicksnumberoptional
Total click count, or null if not yet available.
errorMsgstringoptional
Error message from the first failed submission, or null.
deletedOnstringoptional
When this post was unpublished, as an ISO 8601 timestamp, or null.
totalnumberoptional
Total number of matching posts.
statsobjectoptional
Aggregate stats across the matching posts.
totalPostsnumberoptional
Number of matching posts.
totalViewsnumberoptional
Total views across the matching posts, or null.
totalClicksnumberoptional
Total clicks across the matching posts, or null.
totalEngagementnumberoptional
Total reactions, shares, and comments combined across the matching posts.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/posts
Your API key
locationId *
platform
type
status
from
to
search
page
perPage
{
  "data": {
    "rows": [
      {
        "id": "cm_post_abc123",
        "name": "Fall Special Announcement",
        "type": "announcement",
        "status": "scheduled",
        "postDate": "2026-02-10T15:00:00.000Z",
        "platforms": [
          "google",
          "facebook"
        ],
        "firstMediaUrl": "https://cdn.synup.com/uploads/a1/promo.jpg",
        "firstMediaType": "image",
        "submissions": [
          {
            "platform": "google",
            "status": "pending",
            "postLink": null,
            "reviewState": null,
            "errorMessage": null
          },
          {
            "platform": "facebook",
            "status": "pending",
            "postLink": null,
            "reviewState": null,
            "errorMessage": null
          }
        ],
        "messagePreview": "Join us this weekend for our fall special — 20% off all services!",
        "views": null,
        "clicks": null,
        "errorMsg": null,
        "deletedOn": null
      }
    ],
    "total": 1,
    "stats": {
      "totalPosts": 12,
      "totalViews": 4300,
      "totalClicks": 210,
      "totalEngagement": 96
    }
  }
}