List posts

Returns posts created for the profiles available to the API key, newest first. Read-only and read-write API keys are accepted. Published posts include a platformPostUrl for each published platform target. Results are capped to the 1000 most recent matching posts.

Authorization

bearerAuth

AuthorizationBearer <token>

PostZen API key.

In: header

Query Parameters

profileId?string

Filter posts by profile id.

accountId?string

Filter posts to those targeting a specific connected account.

platform?string

Filter posts to those with a target on this platform. twitter is accepted as an alias for x.

status?string

Filter posts by status.

dateFrom?string

Only include posts scheduled on or after this ISO 8601 timestamp. Posts without a scheduled time are excluded when a date filter is supplied.

dateTo?string

Only include posts scheduled on or before this ISO 8601 timestamp. Posts without a scheduled time are excluded when a date filter is supplied.

sortBy?string

Sort order. createdAt sorts by creation time (newest first). scheduledFor sorts by scheduled time (newest first) and excludes posts without a scheduled time.

page?integer

1-based page number. Defaults to 1.

limit?integer

Page size. Defaults to 20.

Response Body

`application/json`

curl -X GET "https://example.com/v1/posts"

{  "posts": [    {      "_id": "jx58t2kqm4wr9v3n7c1zp6bs0dh5fg8y",      "title": "Launch post",      "content": "We shipped the new release.",      "status": "published",      "scheduledFor": null,      "timezone": "UTC",      "platforms": [        {          "platform": "twitter",          "accountId": {            "_id": "j97kp4mw2xnv6r1t8c3zq5bs9fh0yg4d",            "platform": "twitter",            "username": "acme",            "displayName": "Acme",            "isActive": true          },          "status": "published",          "platformPostUrl": "https://x.com/acme/status/1934567890123456789"        }      ]    }  ],  "pagination": {    "page": 1,    "limit": 20,    "total": 1,    "totalPages": 1  }}

{  "error": "JSON body is required"}

{  "error": "Unauthorized"}

{  "error": "API key requires read_write permission"}

{  "error": "Not found"}

{  "error": "rate_limited",  "retryAfter": 30}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`