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

GET/v1/posts

API key or access tokenKept in this tab only, and sent only to api.sofia-post.com.establishmentId (query)cursor (query)status (query)from (query)to (query)createdBy (query)limit (query)

curl -X GET 'https://api.sofia-post.com/api/v1/posts' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

Authorizations

Authorizationstringrequired
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

200application/json

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

400

invalid_cursor, or invalid_request for a malformed parameter.

401

The token is missing, unknown, expired or revoked.

403

The token does not have the posts:read scope.

404

establishment_not_found: the establishment is out of reach of the token.

4XXapplication/json

Any other error, in the error envelope.