# API reference

> Every operation by resource, the OpenAPI document and the interactive reference.

Source: https://developers.processcart.com/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](https://developers.processcart.com/guides/authentication)).

| Resource | Operations | What it covers |
| --- | --- | --- |
| [Me](https://developers.processcart.com/reference/me) | 1 | The key and workspace behind a credential — the first call every integration should make. |
| [Workflows](https://developers.processcart.com/reference/workflows) | 6 | Published workflow templates: list, read, create from a portable template JSON, read the per-workflow field schema. |
| [Runs](https://developers.processcart.com/reference/runs) | 6 | Runs of a workflow — the central resource: every field value (canonical + formatted) and every task's state in one document. |
| [Tasks](https://developers.processcart.com/reference/tasks) | 5 | Complete, reopen, approve and reject a run's tasks under the engine's gates. |
| [Fields](https://developers.processcart.com/reference/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](https://developers.processcart.com/reference/comments) | 3 | Task comments on a run. |
| [Files](https://developers.processcart.com/reference/files) | 5 | Two-phase file upload to a run's File fields, and signed downloads. |
| [Activity](https://developers.processcart.com/reference/activity) | 1 | A run's append-only activity trail. |
| [Views](https://developers.processcart.com/reference/views) | 6 | Shared saved views (filters + sort) and the runs they select. |
| [Webhooks](https://developers.processcart.com/reference/webhooks) | 12 | Webhook endpoints, their signing secrets and the delivery log. |
| [Schedules](https://developers.processcart.com/reference/schedules) | 9 | Recurrence schedules that start runs of a workflow: create, pause, resume, run now and preview the next occurrences. |
| [Automation rules](https://developers.processcart.com/reference/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](https://developers.processcart.com/reference/directory) | 2 | Members and groups — ids, names, roles; never email addresses. |
| [Exports](https://developers.processcart.com/reference/exports) | 1 | CSV export of a workflow's runs. |
| [Health](https://developers.processcart.com/reference/health) | 1 | The unauthenticated status probe behind the status page. |

Also generated from the code:

- [Scopes](https://developers.processcart.com/reference/scopes) — what each key scope allows.
- [Events](https://developers.processcart.com/reference/events) — every webhook event type and its `data`.
- [Errors](https://developers.processcart.com/errors) — every Problem Details `code`, the `type` target.
- [Field typing](https://developers.processcart.com/reference/field-typing) — how each field type reads and writes.
- [Limits and schedules](https://developers.processcart.com/reference/limits) — every published number.
- [Schemas](https://developers.processcart.com/reference/schemas) — every component schema of the OpenAPI document.

Machine-readable:

- [OpenAPI 3.1 — JSON](https://developers.processcart.com/openapi.json) · [YAML](https://developers.processcart.com/openapi.yaml) (the interactive reference below renders the same document)
- [llms.txt](https://developers.processcart.com/llms.txt) · [llms-full.txt](https://developers.processcart.com/llms-full.txt) — this site as Markdown for AI tools; every page also has a `.md` twin 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.