API Reference
Interactive reference for the Postify public REST API (/v1) — every operation with its parameters, request and response schemas, required scopes, and runnable examples.
Generated from the OpenAPI 3.1 spec: one page per operation, with the full parameter and schema detail, the scopes it needs, and a request you can run against your own workspace.
New to the API? Start at API documentation — auth, scopes, RFC 9457 errors, pagination, idempotency and rate limits in one place — then come back here for per-operation detail.
Analytics
| Operation | Endpoint | Summary |
|---|---|---|
getAnalytics | GET /v1/analytics | Get workspace analytics |
Channels
| Operation | Endpoint | Summary |
|---|---|---|
listChannels | GET /v1/channels | List channels |
Media
| Operation | Endpoint | Summary |
|---|---|---|
listMedia | GET /v1/media | List media assets |
createMediaUpload | POST /v1/media/uploads | Start a media upload |
completeMediaUpload | POST /v1/media/uploads/{id}/complete | Complete a media upload |
Posts
| Operation | Endpoint | Summary |
|---|---|---|
listPosts | GET /v1/posts | List posts |
createPost | POST /v1/posts | Create a post |
getPost | GET /v1/posts/{id} | Get a post |
reschedulePost | PATCH /v1/posts/{id} | Reschedule a post |
deletePost | DELETE /v1/posts/{id} | Delete a post |
publishPost | POST /v1/posts/{id}/publish | Publish a post now |
Usage
| Operation | Endpoint | Summary |
|---|---|---|
getUsage | GET /v1/usage | Get plan usage |
Webhooks
| Operation | Endpoint | Summary |
|---|---|---|
listWebhookEndpoints | GET /v1/webhook-endpoints | List webhook endpoints |
createWebhookEndpoint | POST /v1/webhook-endpoints | Create a webhook endpoint |
updateWebhookEndpoint | PATCH /v1/webhook-endpoints/{id} | Update a webhook endpoint |
deleteWebhookEndpoint | DELETE /v1/webhook-endpoints/{id} | Delete a webhook endpoint |
testWebhookEndpoint | POST /v1/webhook-endpoints/{id}/test | Send a test delivery |
Machine-readable
Every page here has a Markdown twin: append .md to its URL. The whole
surface is indexed in llms.txt, and the
spec is the generator's own input — see For AI agents.
Webhooks
Subscribe to 5 workspace event types over Standard-Webhooks-signed HTTPS deliveries — envelope contract, HMAC verification with a runnable Node snippet, the 9-attempt retry schedule, and the failure ladder.
Get workspace analytics GET
Workspace-level publishing summary: post counts, delivery success, a 14-day publish timeline, and summed engagement across synced platforms.
