API reference · Posts

List posts

GET /v1/posts

List posts by creation time (default), or use state=scheduled and sort=scheduledAt to walk a scheduled calendar chronologically. The scheduled cursor remains valid if earlier posts are cancelled.

Request

Authenticate with a bearer API key. Agents calling over MCP authorise with OAuth instead and never handle the key.

curl -X GET https://api.postlake.dev/v1/posts \
  -H "Authorization: Bearer $POSTLAKE_API_KEY"

Parameters

FieldTypeRequiredWhat it is
sortstringNoQuery string. scheduledAt requires state=scheduled. Return posts in ascending scheduled time with stable keyset pagination.
qstringNoQuery string. Case-insensitive literal caption search, applied before pagination.
campaignstringNoQuery string. Exact campaign slug.
targetCountstringNoQuery string. Single-destination or shared multi-destination posts.
statestringNoQuery string.
accountstringNoQuery string. Filter to posts that targeted this connected account id (acc_…).
profilestringNoQuery string. Filter to posts that targeted a channel in this profile (username).
networkstringNoQuery string. Filter to posts that targeted this social network.
agentstringNoQuery string. Filter by stable agent id (plc_… or key_…). Use `any` for all machine-created posts or `manual` for dashboard-created posts.
surfacestringNoQuery string. Filter by creation surface. This distinguishes dashboard work, direct API integrations, and agent tools.
approvalstringNoQuery string. Filter the human approval workflow.
fromstringNoQuery string. Include posts on or after this date. Uses published time, scheduled time, then creation time.
tostringNoQuery string. Include posts on or before this date. Uses published time, scheduled time, then creation time.
limitintegerNoQuery string.
cursorstringNoQuery string.

Response

Success (200).

FieldTypeRequiredWhat it is
postsarrayYes
nextCursorstring or nullYes

Example

{
  "posts": [
    "…"
  ],
  "nextCursor": "…"
}

Paging

Pass limit (1 to 100, default 50) and the cursor returned by the previous page. A response with a null cursor is the last page. Every list endpoint pages the same way, so one helper covers all of them.

Limits

Reads are limited to 600 requests a minute per account. Every response carries X-RateLimit-Remaining and X-RateLimit-Reset, and a 429 includes Retry-After so a client can back off without guessing. Reads of network data (comments, followers, conversations) are metered in credits; reads of your own PostLake state are not.

Calling this from an agent

Agents do not call REST. They call tools. Over the hosted MCP server this operation is list_posts, and the agent authorises with OAuth so your API key is never pasted into a chat or seen by the model. The reply comes back in the same normalised shape you see above, which is what lets an agent reason about it without a per-network branch.

You control what any one agent may do with it: which brands it may act for, which networks it may reach, how much it may do in a day, and whether it may spend credits you bought up front. See the MCP server.

Errors

Every failure uses one shape: a stable type, a granular code, the field at fault in param, and a plain-language fix. An agent can act on it without a person reading the message. See Errors and retries.

Check the result before retrying a write. Only operations that explicitly support idempotency can safely replay an Idempotency-Key.

Common questions

Can an AI agent do this without the REST API?

Yes. Over MCP the same job is the list_posts tool. The agent authorises with OAuth, so no API key is pasted into a chat or seen by the model, and the answer comes back in the same normalised shape.

How often can I call this?

Reads are rate limited per account and every response carries X-RateLimit-Remaining and X-RateLimit-Reset. On a 429 the Retry-After header tells you how long to wait.

What happens when it fails?

You get one error shape: a stable type, a granular code you can branch on, the offending field in param, and a fix written so an agent can correct itself rather than stop. Full list on Errors and retries.

Related