# Process Cart API

> The Process Cart REST API: workflows, runs, tasks, field values, comments, files, saved views, webhooks, schedules, automation rules and the member directory of a workspace. Base URL https://app.processcart.com/api/v1; API keys with action scopes; RFC 9457 errors; cursor pagination with incremental sync; Standard Webhooks; OpenAPI 3.1.

Every page is served as HTML at its URL and as Markdown at the same URL with `.md` appended (the links below). The whole site in one file: llms-full.txt. The OpenAPI 3.1 document is the machine-readable contract; the pages explain the conventions around it.

## Docs

- [Process Cart API](https://developers.processcart.com/index.md): Start a run, set its fields and complete a task from curl in five minutes — then read the conventions every endpoint follows.
- [Plans, limits & access](https://developers.processcart.com/guides/plans.md): The API and webhooks are included for every workspace at no additional cost; keys are self-serve; the limits are the same for everyone.
- [API reference](https://developers.processcart.com/reference.md): Every operation by resource, the OpenAPI document and the interactive reference.
- [Me endpoints](https://developers.processcart.com/reference/me.md): The key and workspace behind a credential — the first call every integration should make. Every operation with parameters, body, responses, errors and examples.
- [Workflows endpoints](https://developers.processcart.com/reference/workflows.md): Published workflow templates: list, read, create from a portable template JSON, read the per-workflow field schema. Every operation with parameters, body, responses, errors and examples.
- [Runs endpoints](https://developers.processcart.com/reference/runs.md): Runs of a workflow — the central resource: every field value (canonical + formatted) and every task's state in one document. Every operation with parameters, body, responses, errors and examples.
- [Tasks endpoints](https://developers.processcart.com/reference/tasks.md): Complete, reopen, approve and reject a run's tasks under the engine's gates. Every operation with parameters, body, responses, errors and examples.
- [Fields endpoints](https://developers.processcart.com/reference/fields.md): Set a run's field values in one transaction; a JSON number is the canonical, a string is parsed by the field's format. Every operation with parameters, body, responses, errors and examples.
- [Comments endpoints](https://developers.processcart.com/reference/comments.md): Task comments on a run. Every operation with parameters, body, responses, errors and examples.
- [Files endpoints](https://developers.processcart.com/reference/files.md): Two-phase file upload to a run's File fields, and signed downloads. Every operation with parameters, body, responses, errors and examples.
- [Activity endpoints](https://developers.processcart.com/reference/activity.md): A run's append-only activity trail. Every operation with parameters, body, responses, errors and examples.
- [Views endpoints](https://developers.processcart.com/reference/views.md): Shared saved views (filters + sort) and the runs they select. Every operation with parameters, body, responses, errors and examples.
- [Webhooks endpoints](https://developers.processcart.com/reference/webhooks.md): Webhook endpoints, their signing secrets and the delivery log. Every operation with parameters, body, responses, errors and examples.
- [Schedules endpoints](https://developers.processcart.com/reference/schedules.md): Recurrence schedules that start runs of a workflow: create, pause, resume, run now and preview the next occurrences. Every operation with parameters, body, responses, errors and examples.
- [Automation rules endpoints](https://developers.processcart.com/reference/automation-rules.md): When-then rules on a workflow's runs (set fields, status, labels, assignees; notify; send to a webhook) and their execution history. Every operation with parameters, body, responses, errors and examples.
- [Directory endpoints](https://developers.processcart.com/reference/directory.md): Members and groups — ids, names, roles; never email addresses. Every operation with parameters, body, responses, errors and examples.
- [Exports endpoints](https://developers.processcart.com/reference/exports.md): CSV export of a workflow's runs. Every operation with parameters, body, responses, errors and examples.
- [Health endpoints](https://developers.processcart.com/reference/health.md): The unauthenticated status probe behind the status page. Every operation with parameters, body, responses, errors and examples.
- [Scopes](https://developers.processcart.com/reference/scopes.md): What each API key scope allows, and the read-only rule.
- [Events](https://developers.processcart.com/reference/events.md): Every webhook event type, when it fires and what its data carries; the envelope.
- [Field typing](https://developers.processcart.com/reference/field-typing.md): How every field type reads (value, formatted, blank) and writes, generated from the typing rule.
- [Limits and schedules](https://developers.processcart.com/reference/limits.md): Every published limit — rate, sizes, pages, keys, files, webhooks — and the retry schedule.
- [Schemas](https://developers.processcart.com/reference/schemas.md): Every component schema of the OpenAPI document with its properties.
- [Authentication & API keys](https://developers.processcart.com/guides/authentication.md): Bearer keys with action scopes, read-only keys, workflow and folder allowlists, rotation with a 24-hour grace period, and revocation — all self-serve.
- [TypeScript SDK](https://developers.processcart.com/guides/sdk.md): The official TypeScript client — typed methods for every operation, cursor pagination, idempotency keys, retries and webhook verification.
- [Sandbox workspaces](https://developers.processcart.com/guides/sandbox.md): Build and test an integration against a separate workspace flagged as a sandbox — pc_test_ keys, the same base URL, data isolated from your live workspace.
- [Runs](https://developers.processcart.com/guides/runs.md): The central resource — every field value (canonical + formatted) and every task's state in one document — and how to list, start, update, trash and restore runs.
- [Field values & typing](https://developers.processcart.com/guides/field-values.md): Every field reads as a canonical value plus a formatted string, typed by its format — numbers stay numbers, percents are fractions, dates are YYYY-MM-DD — and writes take the canonical or a human string.
- [Tasks, approvals & files](https://developers.processcart.com/guides/tasks-approvals-files.md): Complete, reopen, approve and reject tasks under the engine's gates, and attach files to File fields with a two-phase upload.
- [Comments & activity](https://developers.processcart.com/guides/comments-activity.md): Post and read task comments (plain text or a rich document, strictly sanitized, with mentions) and read the run's append-only activity trail.
- [Workflows & schema](https://developers.processcart.com/guides/workflows.md): List and read workflows, read a published version's tree and its JSON Schema, update workflow-level settings, and import or export the portable template.
- [Views & exports](https://developers.processcart.com/guides/views-exports.md): Read the shared saved views of a workspace and the runs they select, create and change views owned by your key's creator, and export a workflow's runs as CSV.
- [Webhooks](https://developers.processcart.com/webhooks.md): Signed, retried deliveries of every event (Standard Webhooks) — create endpoints, verify signatures in Node or Python, understand the retry schedule and auto-disable, redeliver, and dedupe.
- [Directory](https://developers.processcart.com/guides/directory.md): The workspace's members (ids, names, roles, avatars — never email addresses) and groups, the ids that assignments, Members fields and assignee filters use.
- [Schedules](https://developers.processcart.com/guides/schedules.md): Start runs of a workflow on a recurrence — daily, weekly, monthly or yearly at a set time — with a run-name pattern, preset field values and per-task assignees; pause, resume, run now and preview.
- [Automation rules](https://developers.processcart.com/guides/automation-rules.md): When-then rules on a workflow's runs — a trigger event, an optional task or field filter and field conditions, then actions that set fields, status, priority, labels and assignees, notify people or send the event to a webhook.
- [Pagination](https://developers.processcart.com/guides/pagination.md): Every collection answers { data, nextCursor, hasMore } with opaque cursors, a published page-size ceiling, strict query parameters and a stable order per endpoint.
- [Incremental sync](https://developers.processcart.com/guides/incremental-sync.md): updatedSince on the six lists — inclusive, ordered by updatedAt ascending, with an overlap-and-dedupe recipe keyed by (id, revision) on runs and (id, updatedAt) elsewhere.
- [Idempotency](https://developers.processcart.com/guides/idempotency.md): Send Idempotency-Key on any POST, PATCH or DELETE to make retries safe — a byte-identical retry replays the stored answer; a different body with the same key is refused.
- [Concurrency](https://developers.processcart.com/guides/concurrency.md): Every Run carries its revision; every write that changes an existing run accepts Expected-Revision and refuses a stale revision with 409 revision_mismatch, whose body names currentRevision — checked inside the run's lock. The API sends no ETag and refuses If-Match.
- [Errors](https://developers.processcart.com/errors.md): Every failure is an RFC 9457 problem with a stable machine-readable code, a human message, the right HTTP status, a request id and field-level errors[].
- [Rate limits](https://developers.processcart.com/guides/rate-limits.md): 600 requests per minute per key, RateLimit-* headers on every response to an authenticated request, a 429 with Retry-After when exceeded, and the unauthenticated health probe.
- [Versioning & deprecation](https://developers.processcart.com/guides/versioning.md): The version is in the path (/v1); additive changes ship without a bump; breaking changes get /v2 with at least twelve months of overlap, Deprecation and Sunset headers and a changelog entry.
- [OpenAPI](https://developers.processcart.com/guides/openapi.md): The OpenAPI 3.1 document — JSON and YAML, generated from the same schemas the API validates with — and how to use it for code generation.
- [Changelog](https://developers.processcart.com/changelog.md): Every change to the API, dated — what shipped, what it covers, what is coming.
- [Status & uptime](https://developers.processcart.com/status.md): The public status page shows live status, incident history and 90-day uptime for the web app, the API and scheduled jobs & webhooks.
- [MCP server](https://developers.processcart.com/guides/mcp.md): Connect Claude, Cursor and other MCP clients to Process Cart with the @processcart/mcp server — find workflows, start runs, set fields, complete tasks and read activity with your API key.

## Reference

- [OpenAPI 3.1 (JSON)](https://developers.processcart.com/openapi.json): every operation, schema, header and webhook event; suitable for code generation.
- [OpenAPI 3.1 (YAML)](https://developers.processcart.com/openapi.yaml): the same document as YAML.
- [llms-full.txt](https://developers.processcart.com/llms-full.txt): every page of this site as one Markdown file, in reading order.
- [Status page](https://status.processcart.com): live status, incident history and uptime for the web app, the API and scheduled jobs & webhooks.