PostsList posts

Posts

List posts

Lists the posts of the establishments in reach of the token, newest first, filtered by establishment, status, date window and author, page by page.

GEThttps://api.sofia-post.com/api/v1/posts
GEThttps://api.sofia-post.com/api/v1/posts

List posts

Lists the posts of the establishments in reach of the token, newest first, filtered by establishment, status, date window and author, page by page.

Authorizations

Authorizationstringrequired

Your personal key or OAuth access token, sent as Bearer <token>.

Kept in this tab only, and sent only to api.sofia-post.com. Get an API key

Query parameters

establishmentIdstring

Only the posts of this establishment.

cursorstring

The nextCursor of the previous page.

statusstring

Live: at least one network in this state. The post status summarizes its networks, so filtering on failed can return partial.

fromstring<date-time>

Live: at least one network published (or, before publication, scheduled) from this instant.

tostring<date-time>

Live: and before this instant (excluded).

createdBystring

Live: me for the posts of the person the token acts for, app for those this application created. Absent: all.

limitnumber

Page size, from 1 to 100 (default 20).

GET /v1/posts lists all the posts accessible to the token, most recent first, filtered by establishmentId, status, from, to and createdBy (me or app). A post matches status when at least one of its networks is in that state. See pagination.

The possible states of a post are described on the Read a post page.

Authorizations

  • Authorizationstringheaderrequired

    Your personal key or OAuth access token, sent as Bearer <token>.

Query parameters

  • establishmentIdstring

    Only the posts of this establishment.

  • cursorstring

    The nextCursor of the previous page.

  • statusstring

    Live: at least one network in this state. The post status summarizes its networks, so filtering on failed can return partial.

    Allowed values: draftscheduledpublishingpublishedsent_to_inboxfailed

  • fromstring<date-time>

    Live: at least one network published (or, before publication, scheduled) from this instant.

  • tostring<date-time>

    Live: and before this instant (excluded).

  • createdBystring

    Live: me for the posts of the person the token acts for, app for those this application created. Absent: all.

    Allowed values: meapp

  • limitnumber

    Page size, from 1 to 100 (default 20).

Response

A page of posts, with nextCursor when more follow.

  • dataobject[]required

    The posts of the page

    Show child attributes
    • idstringrequired

      Identifier of the post

    • statusstringrequired

      Across all networks; partial: published on one, failed on another

      Allowed values: draftscheduledpublishingpublishedsent_to_inboxfailedpartial

    • establishmentIdstringrequired

      Establishment of the post

    • createdAtstring<date-time>required

      When the post was created

    • targetsobject[]required

      One entry per network and account: two accounts on one network, two entries

      Show child attributes
      • platformstringrequired

        Network of the target

      • accountIdstringrequired

        The account that publishes (GET /v1/establishments/:id/accounts)

      • statestringrequired

        State of the target on its network

        Allowed values: draftscheduledpublishingpublishedsent_to_inboxfailed

      • publishedAtstring<date-time>

        When the target was published

      • permalinkstring

        Link to the published post on the network

      • errorstring

        Why the network refused

    • scheduledAtstring<date-time>

      When the post is scheduled to be published

  • nextCursorstring

    Pass it as ?cursor= for the next page; absent at the end

Was this page helpful?