API reference
Every operation by resource, the OpenAPI document and the interactive reference.
Every /api/v1 operation, generated from the same operation registry the routes are built on. Base URL https://app.processcart.com/api/v1 — send your key as Authorization: Bearer <key> (Authentication).
| Resource | Operations | What it covers |
|---|---|---|
| Me | 1 | The key and workspace behind a credential — the first call every integration should make. |
| Workflows | 6 | Published workflow templates: list, read, create from a portable template JSON, read the per-workflow field schema. |
| Runs | 6 | Runs of a workflow — the central resource: every field value (canonical + formatted) and every task's state in one document. |
| Tasks | 5 | Complete, reopen, approve and reject a run's tasks under the engine's gates. |
| Fields | 1 | Set a run's field values in one transaction; a JSON number is the canonical, a string is parsed by the field's format. |
| Comments | 3 | Task comments on a run. |
| Files | 5 | Two-phase file upload to a run's File fields, and signed downloads. |
| Activity | 1 | A run's append-only activity trail. |
| Views | 6 | Shared saved views (filters + sort) and the runs they select. |
| Webhooks | 12 | Webhook endpoints, their signing secrets and the delivery log. |
| Schedules | 9 | Recurrence schedules that start runs of a workflow: create, pause, resume, run now and preview the next occurrences. |
| Automation rules | 8 | When-then rules on a workflow's runs (set fields, status, labels, assignees; notify; send to a webhook) and their execution history. |
| Directory | 2 | Members and groups — ids, names, roles; never email addresses. |
| Exports | 1 | CSV export of a workflow's runs. |
| Health | 1 | The unauthenticated status probe behind the status page. |
Also generated from the code:
- Scopes — what each key scope allows.
- Events — every webhook event type and its
data. - Errors — every Problem Details
code, thetypetarget. - Field typing — how each field type reads and writes.
- Limits and schedules — every published number.
- Schemas — every component schema of the OpenAPI document.
Machine-readable:
- OpenAPI 3.1 — JSON · YAML (the interactive reference below renders the same document)
- llms.txt · llms-full.txt — this site as Markdown for AI tools; every page also has a
.mdtwin at its own URL
Interactive reference
The reference below is rendered from the OpenAPI document in your browser. Try-it is off (the API sets no CORS headers — keys never belong in browser code); use the per-language snippets and the worked examples instead.