PostsGet a post
Back to Sofia

Posts

Get a post

Returns a post with the state of each network, its link once published and its error if it failed. Live reads any post of the Workspace, test a simulated one.

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

Authorizations

  • Authorizationstringrequired

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

Path parameters

  • idstringrequired

    Identifier of the post.

Response

200application/json

The post and the state of each target.

  • 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

401

The token is missing, unknown, expired or revoked.

403

The token does not have the posts:read scope.

404

post_not_found: outside the Workspace (or the grant in test).

4XXapplication/json

Any other error, in the error envelope.