v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
Posts

List posts

Returns a paginated list of posts. Published posts include platformPostUrl with the public URL on each platform.

get/v1/posts

Query parameters

pageinteger

Page number (1-based)

limitinteger

Page size. Values above the maximum return 400 rather than being clamped.

source'zernio' | 'external'

Which collection to read. zernio (default) returns posts authored through Zernio. external returns posts synced from the platform (existing/historical posts that were published outside Zernio). Combine with accountId and paginate via page/limit to walk the full synced history (we keep up to the last ~12 months per account).

status'draft' | 'scheduled' | 'published' | 'failed'
platformstring
Example:twitter
profileIdstring

Filter posts to a specific profile (24-char hex ObjectId). Omit it, or send all or an empty value, to list posts across every profile.

createdBystring

Filter posts to those created by a specific team user (24-char hex ObjectId).

dateFromstring date

Zero-padded YYYY-MM-DD, or a full ISO 8601 datetime. An empty value means no date filter; any other malformed value returns 400.

dateTostring date

Zero-padded YYYY-MM-DD, or a full ISO 8601 datetime. An empty value means no date filter; any other malformed value returns 400.

includeHiddenboolean
searchstring

Search posts by text content.

sortBy'scheduled-desc' | 'scheduled-asc' | 'created-desc' | 'created-asc' | 'status' | 'platform'

Sort order for results.

accountIdstring

Filter posts to those published via a specific social account (24-char hex ObjectId).

Response

Paginated posts

Example response

{
  "posts": [
    {
      "platforms": [
        {
          "platform": "twitter",
          "platformSpecificData": {
            "geoRestriction": {
              "countries": [
                "US",
                "CA",
                "GB"
              ]
            }
          },
          "status": "pending",
          "platformPostId": "1234567890123456789",
          "platformPostUrl": "https://twitter.com/acmecorp/status/1234567890123456789"
        }
      ]
    }
  ]
}