API Reference & Interactive Docs
Full endpoint reference with interactive testing at /api/docs.
The full API reference with interactive testing is available at /api/docs.
What You Can Do
The API supports the full order lifecycle:
- Create orders from external systems, automation tools, or custom integrations
- List and search orders with filtering by stage, flow, platform, triage status, and archive state
- Update order details including tracking info, notes, and customer data
- Move orders between stages to progress through your workflow
- Triage orders by assigning them to a specific flow
- Archive and unarchive orders to manage your Kanban board
You can also list your workspace's stages and flows to build dynamic integrations.
Interactive Docs
Visit /api/docs to explore every endpoint, see request/response schemas, and test API calls with your own API key directly in the browser.
Quick Links
- API Overview — Authentication, base URL, response format
- Creating Orders via API — Detailed guide for the POST /orders endpoint
- Managing API Keys — How to generate and rotate keys
- Outgoing Webhooks — Receive events when orders change