Scheduling
List Scheduled
Retrieve a paginated list of scheduled posts awaiting publication.
Endpoint
GET https://api.postpeer.dev/v1/posts/scheduledQuery Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 20 | Page size (1–100) |
offset | integer | 0 | Number of scheduled posts to skip |
sort | string | "asc" | Sort by scheduledFor: "asc" (next post first) or "desc" |
Example
curl "https://api.postpeer.dev/v1/posts/scheduled?limit=5&offset=0" \
-H "x-access-key: YOUR_API_KEY"Response
{
"success": true,
"total": 12,
"posts": [
{
"postId": "post_xyz789",
"content": "This post will go live tomorrow morning!",
"scheduledFor": "2026-03-29T13:00:00.000Z",
"timezone": "America/New_York",
"mediaItems": [],
"platforms": [
{ "platform": "twitter", "status": "pending" }
],
"createdAt": "2026-03-28T15:00:00.000Z"
}
]
}total is the total number of scheduled posts matching the filter (across all pages). Walk the result set by incrementing offset by limit until you've fetched total items.
Status Codes
| Code | Meaning |
|---|---|
200 | Success |
400 | Invalid query parameters |