API

Base URL:

https://app.postonus.com/api/v1

The dashboard, the CLI, and the MCP server all call the same operations behind this prefix — there is no separate internal API. One contract package (@postonus/api-contract) describes every path, method, input, and error; the OpenAPI document generated from it is what the reference is built from.

Authenticate with an API key, sent as x-api-key. Create one from Developer API in the dashboard sidebar. See Authentication.

First call

Verify your key and see who it belongs to:

curl https://app.postonus.com/api/v1/users/me \
  -H "x-api-key: $POSTONUS_API_KEY"

{
  "id": "usr_...",
  "name": "Ada Lovelace",
  "email": "ada@example.com",
  "image": null,
  "emailVerified": true,
  "createdAt": "2026-08-01T09:30:00.000Z",
  "updatedAt": "2026-08-01T09:30:00.000Z",
  "defaultOrganizationId": "org_..."
}

What the API is for

Scheduling and publishing posts, reading your queue, connecting channels, and uploading media — the same things the composer does, callable from a script. An API key reaches a subset of the full surface; see Public surface for exactly which operations that is and why.

Read next

• Quickstart — schedule a post end to end.
• Authentication — keys, scoping, revocation.
• Workspaces — how the active workspace is resolved.
• Errors — the error shape and the codes you will actually see.
• Pagination — list responses.
• Rate limits — the three buckets, by plan.
• Reference — every operation, generated from the contract.