Postforge developers
Build on Postforge, the open-source ecommerce email platform, with its REST API.
Everything the Postforge dashboard does goes through the same REST API you can call: workspaces, stores, profiles, orders, products, coupons, feeds and the typed definitions behind automations, segments, templates and campaigns. People, API keys and AI clients get the same operations with the same permissions.
Quickstart
Create an API key and make your first request in five minutes.
Authentication
Workspace API keys, their scopes and how to keep them safe.
API reference
Every operation, its parameters and its answers, from the OpenAPI spec.
Problems
The errors the API answers, as RFC 9457 problem details.
At a glance
| Base URL | https://api.postforge.dev/v1 |
| Format | JSON in and out, camelCase |
| Authentication | Authorization: Bearer pf_… (a workspace API key) |
| Errors | RFC 9457 problem details |
| Retries | Idempotency-Key on every write |
| Limits | 600 requests a minute per key |
| Spec | openapi.json (OpenAPI 3.1) |
| Schemas | /v1/schemas (JSON Schema for definitions) |
For AI agents
Postforge is built for AI to set up and operate. Agents read
llms.txt (the index) or
llms-full.txt (every docs page in one file), add .md to
any docs page for its Markdown, call the API with a workspace key, and write
definitions against their JSON Schemas; changes made with a propose
key become proposals a person approves. An MCP server is coming before launch.
Postforge is in development
Until version 1 the API can change without notice. From launch, /v1 follows the
versioning policy.