Skip to main content
POST
social.posts.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
status
enum<string>

Only posts in this state.

Available options:
pending_approval,
draft,
scheduled,
publishing,
published,
partial,
failed,
cancelled
platform
string

Only posts going to this platform, lowercase, as in social.accounts.list.

Required string length: 1 - 64
accountId
string

Only posts going to this connected account, from social.accounts.list.

Required string length: 1 - 256

Only posts whose text contains these words.

Required string length: 1 - 256
fromDate
string

Only posts from this date or time (ISO 8601) onwards.

Required string length: 1 - 40
toDate
string

Only posts up to this date or time (ISO 8601).

Required string length: 1 - 40
source
enum<string>
default:api

api (default): posts published through this API. platform: the connected accounts' own history, synced from the platforms (up to about the last 12 months).

Available options:
api,
platform
sortBy
enum<string>
default:scheduled-desc

Sort order. Default scheduled-desc: next scheduled first.

Available options:
scheduled-desc,
scheduled-asc,
created-desc,
created-asc,
status,
platform
includeHidden
boolean
default:false

Also include posts hidden from your view.

limit
number

How many posts to return, 1 to 50. Default 10.

Required range: x >= 1
cursor
string

The nextCursor of the previous page, to get the next one.

Required string length: 1 - 1024

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.