Get a post

One post and its status. Add ?insights=1 for its live platform status and metrics instead. Needs the read permission.

GET

https://mixetape.com/api/v1/posts/{id}

View as Markdown

Authorisation

apiKeyHTTPrequired

Path parameters

idstringrequired

Query parameters

insightsoptionalstring
Any value: answer with get_post_insights' result instead

Returns

200

The post.

JSON

postobjectrequired
16 properties
- idstringrequired
- accountIdstringrequired
- providerstringrequired
- mediaUrlstringrequired
- scheduledAtstringrequired
  When it goes live
  
  format: date-time
- statusscheduledorpublishingoruploadedorpublishedorfailedorcancelledrequired
- captionoptionalstring | null
- metadataoptionalobject | null
  The platform's own fields
- leadMinutesoptionalinteger | null
  Uploaded or prepared this long before scheduledAt
- platformPostIdoptionalstring | null
- platformUrloptionalstring | null
- erroroptionalstring | null
  Why it failed, when it did
- attemptsoptionalinteger
- publishedAtoptionalstring | null
  format: date-time
- createdAtoptionalstring
  format: date-time
- updatedAtoptionalstring
  format: date-time

400

The request is invalid; error says why.

JSON

errorstringrequired
What went wrong, in plain words

401

No valid API key.

JSON

errorstringrequired
What went wrong, in plain words

403

The key lacks the permission this needs.

JSON

errorstringrequired
What went wrong, in plain words

404

Not found, or not yours.

JSON

errorstringrequired
What went wrong, in plain words

{ "post": { "id": "string", "accountId": "string", "provider": "string", "mediaUrl": "string", "caption": "string", "metadata": {}, "scheduledAt": "2019-08-24T14:15:22Z", "leadMinutes": 0, "status": "scheduled", "platformPostId": "string", "platformUrl": "string", "error": "string", "attempts": 0, "publishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } }