# Schemas

> Every component schema of the OpenAPI document with its properties.

Source: https://developers.processcart.com/reference/schemas

Every component schema of the [OpenAPI document](https://developers.processcart.com/openapi.json), as a quick lookup: the reference pages link here from their type columns. Objects list their properties; other schemas show their shape. Growable enums (statuses, event types, error codes, field types) are marked open in the document — treat an unknown value as such.

### ActivityActor
Type: object

### ActivityItem
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `runId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `type` | string | yes |  |
| `category` | `"fields"` \\| `"tasks"` \\| `"approvals"` \\| `"files"` \\| `"comments"` \\| `"run"` | yes |  |
| `actor` | [EventActor](https://developers.processcart.com/reference/schemas#eventactor) | yes |  |
| `taskKey` | string \\| null | yes |  |
| `payload` | object (key → any) | yes |  |
| `description` | string | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### Actor
Type: object

### ApiErrorCode
Open enum: new values may be added without a version bump — treat an unknown value as such.

Type: `"unauthorized"` \| `"invalid_api_key"` \| `"key_revoked"` \| `"insufficient_scope"` \| `"read_only_key"` \| `"not_allowed_for_key"` \| `"rate_limited"` \| `"idempotency_key_reused"` \| …

### ApiScope
Type: `"runs:read"` \| `"runs:write"` \| `"approvals:decide"` \| `"workflows:read"` \| `"workflows:write"` \| `"views:read"` \| `"views:write"` \| `"webhooks:manage"` \| …

### Assignment
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `assignees` | object[] | yes |  |

### Attachment
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `runId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `taskKey` | string \\| null | yes |  |
| `fieldKey` | string \\| null | yes |  |
| `commentId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `filename` | string | yes |  |
| `size` | integer | yes |  |
| `contentType` | string | yes |  |
| `uploadedByUserId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `uploadedBy` | [Actor](https://developers.processcart.com/reference/schemas#actor) | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `downloadUrl` | string (uri) | no | A signed download link (`Content-Disposition: attachment`), valid one hour. |
| `downloadExpiresAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | no |  |

### AutomationAssignee
Type: object

### AutomationRule
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `workflowId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `workflow` | object \\| null | yes |  |
| `name` | string | yes |  |
| `triggerEvent` | `"run.created"` \\| `"run.updated"` \\| `"run.status_changed"` \\| `"run.completed"` \\| `"task.ready"` \\| `"task.assigned"` \\| `"task.completed"` \\| `"task.uncompleted"` \\| … | yes |  |
| `filter` | object | yes |  |
| `conditions` | object | yes |  |
| `actions` | object[] | yes |  |
| `enabled` | boolean | yes |  |
| `disabledReason` | `"manual"` \\| `"failures"` \\| `"loop_guard"` \\| null | yes |  |
| `disabledAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `consecutiveFailures` | integer | yes |  |
| `keyMismatches` | object[] | yes |  |
| `createdBy` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `updatedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### AutomationRuleConfig
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes |  |
| `workflowId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `triggerEvent` | `"run.created"` \\| `"run.updated"` \\| `"run.status_changed"` \\| `"run.completed"` \\| `"task.ready"` \\| `"task.assigned"` \\| `"task.completed"` \\| `"task.uncompleted"` \\| … | yes |  |
| `filter` | [RuleFilter](https://developers.processcart.com/reference/schemas#rulefilter) | no |  |
| `conditions` | [RuleConditions](https://developers.processcart.com/reference/schemas#ruleconditions) | no |  |
| `actions` | [RuleAction](https://developers.processcart.com/reference/schemas#ruleaction)[] | yes |  |

### AutomationRuleList
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [AutomationRule](https://developers.processcart.com/reference/schemas#automationrule)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### AutomationRulePatch
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no |  |
| `workflowId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | no |  |
| `triggerEvent` | `"run.created"` \\| `"run.updated"` \\| `"run.status_changed"` \\| `"run.completed"` \\| `"task.ready"` \\| `"task.assigned"` \\| `"task.completed"` \\| `"task.uncompleted"` \\| … | no |  |
| `filter` | [RuleFilter](https://developers.processcart.com/reference/schemas#rulefilter) | no |  |
| `conditions` | [RuleConditions](https://developers.processcart.com/reference/schemas#ruleconditions) | no |  |
| `actions` | [RuleAction](https://developers.processcart.com/reference/schemas#ruleaction)[] | no |  |

### CalendarDate
Type: string

### CanonicalValue
Type: string \| number \| boolean \| string[]

### Comment
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `runId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `taskKey` | [Key](https://developers.processcart.com/reference/schemas#key) | yes |  |
| `runTaskId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `author` | [Actor](https://developers.processcart.com/reference/schemas#actor) & object | yes |  |
| `body` | object | yes | A rich-text document (ProseMirror JSON). Allowed node types: paragraph, text, heading, bulletList, orderedList, listItem, blockquote, codeBlock, hardBreak, horizontalRule, image, table, tableRow, tableCell, tableHeader, mention, mergeTag (attrs.fieldKey must be a valid field key, else dropped), embed (an https video src on YouTube, Loom or Vimeo, else removed); marks: bold, italic, code, link, textStyle, highlight. Anything else is dropped on save. A mention node is `{ type: "mention", attrs: { id: "<member user id>" } }` — its label is always re-derived from the member list. |
| `text` | string | yes |  |
| `mentions` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `editedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `url` | string (uri) | yes |  |

### CreateRunCommentBody
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `taskKey` | string | yes | The task to comment on (any task of the run). |
| `text` | string | no | Plain text: blank lines separate paragraphs, a single newline is a line break, and `@Name` becomes a mention when it matches exactly one member. |
| `body` | object | no | A rich-text document (ProseMirror JSON). Allowed node types: paragraph, text, heading, bulletList, orderedList, listItem, blockquote, codeBlock, hardBreak, horizontalRule, image, table, tableRow, tableCell, tableHeader, mention, mergeTag (attrs.fieldKey must be a valid field key, else dropped), embed (an https video src on YouTube, Loom or Vimeo, else removed); marks: bold, italic, code, link, textStyle, highlight. Anything else is dropped on save. A mention node is `{ type: "mention", attrs: { id: "<member user id>" } }` — its label is always re-derived from the member list. |

### CreateViewBody
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes |  |
| `query` | object | yes | The board query the view selects. Send only the members you set; the rest take the board's defaults: `{"workflowId":null,"status":["active","on_hold"],"priority":[],"labels":[],"assignee":null,"due":null,"q":"","qMode":"prefix","sort":{"key":"started","dir":"desc"},"columns":["status","priority","progress","key_date","due","assignees","started"]}`. `sort.key` without `dir` takes that key's natural direction (`asc` for `name`, `key_date` and `due`, else `desc`). An unknown member is a 422. |
| `visibility` | `"org"` \\| `"groups"` | no |  |
| `groupIds` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] | no |  |

### CreateWorkflowBody
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | [WorkflowTemplate](https://developers.processcart.com/reference/schemas#workflowtemplate) | yes |  |
| `name` | string | no |  |
| `description` | string \\| null | no |  |
| `folderId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | no |  |
| `publish` | boolean | no |  |

### CreateWorkflowResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string | yes |  |
| `description` | string \\| null | yes |  |
| `status` | `"active"` \\| `"archived"` | yes |  |
| `icon` | string \\| null | yes |  |
| `color` | string \\| null | yes |  |
| `folder` | object \\| null | yes |  |
| `keyDateFieldKey` | string \\| null | yes |  |
| `kickoffFormEnabled` | boolean | yes |  |
| `publishedVersion` | object \\| null | yes |  |
| `taskCount` | integer | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `updatedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `sections` | [WorkflowSection](https://developers.processcart.com/reference/schemas#workflowsection)[] | yes |  |
| `rules` | [RuleDef](https://developers.processcart.com/reference/schemas#ruledef)[] | yes |  |
| `import` | [ImportReport](https://developers.processcart.com/reference/schemas#importreport) | yes |  |
| `publishWarnings` | string[] | yes |  |

### Cursor
Type: string

### DueRule
Type: object

### EventActor
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no |  |

### EventApproval
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `decision` | `"approved"` \\| `"rejected"` | yes |  |
| `comment` | string \\| null | yes |  |
| `decidedBy` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `decidedByEmail` | string \\| null | yes |  |
| `decidedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### EventApprovalDecided
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |
| `approval` | [EventApproval](https://developers.processcart.com/reference/schemas#eventapproval) | yes |  |

### EventApprovalRequested
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |

### EventAttachment
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `filename` | string | yes |  |
| `size` | integer | yes |  |
| `mime` | string | yes |  |
| `fieldKey` | string \\| null | yes |  |
| `taskKey` | string | yes |  |
| `commentId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |

### EventAttachmentCreated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |
| `attachment` | [EventAttachment](https://developers.processcart.com/reference/schemas#eventattachment) | yes |  |

### EventComment
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `authorId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `text` | string | yes |  |
| `mentions` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] | yes |  |

### EventCommentCreated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |
| `comment` | [EventComment](https://developers.processcart.com/reference/schemas#eventcomment) | yes |  |

### EventEnvelope
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes |  |
| `type` | [EventType](https://developers.processcart.com/reference/schemas#eventtype) | yes |  |
| `timestamp` | string | yes |  |
| `org` | object | yes |  |
| `actor` | [EventActor](https://developers.processcart.com/reference/schemas#eventactor) | yes |  |
| `data` | object (key → any) | yes |  |

### EventField
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `key` | [FieldKey](https://developers.processcart.com/reference/schemas#fieldkey) | yes |  |
| `label` | string | yes |  |
| `type` | [FieldType](https://developers.processcart.com/reference/schemas#fieldtype) | yes |  |
| `format` | [FormatType](https://developers.processcart.com/reference/schemas#formattype) \\| null | yes |  |
| `taskKey` | [Key](https://developers.processcart.com/reference/schemas#key) | yes |  |
| `value` | [CanonicalValue](https://developers.processcart.com/reference/schemas#canonicalvalue) \\| null | yes |  |
| `formatted` | string | yes |  |
| `visible` | boolean | yes |  |
| `choices` | string[] | no |  |
| `items` | object[] | no |  |
| `validationError` | string | no |  |
| `previous` | [CanonicalValue](https://developers.processcart.com/reference/schemas#canonicalvalue) \\| null | yes |  |

### EventFieldUpdated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `field` | [EventField](https://developers.processcart.com/reference/schemas#eventfield) | yes |  |

### EventGuest
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `email` | string | yes |  |
| `linkId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |

### EventGuestTaskCompleted
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |
| `guest` | [EventGuest](https://developers.processcart.com/reference/schemas#eventguest) | yes |  |

### EventGuestTaskViewed
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |
| `guest` | [EventGuest](https://developers.processcart.com/reference/schemas#eventguest) | yes |  |

### EventRuleCreated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `rule` | [AutomationRule](https://developers.processcart.com/reference/schemas#automationrule) | yes |  |

### EventRuleDeleted
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `rule` | [AutomationRule](https://developers.processcart.com/reference/schemas#automationrule) | yes |  |

### EventRuleUpdated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `rule` | [AutomationRule](https://developers.processcart.com/reference/schemas#automationrule) | yes |  |
| `change` | `"settings"` \\| `"enabled"` \\| `"disabled"` \\| `"auto_disabled"` | yes |  |

### EventRunCompleted
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |

### EventRunCreated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `kickoffLinkId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | no |  |

### EventRunRestored
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) \\| [RunLite](https://developers.processcart.com/reference/schemas#runlite) | yes |  |
| `withWorkflow` | boolean | no |  |

### EventRunStatusChanged
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `changes` | object | yes |  |

### EventRunTrashed
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) \\| [RunLite](https://developers.processcart.com/reference/schemas#runlite) | yes |  |
| `withWorkflow` | boolean | no |  |

### EventRunUpdated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `changes` | object (key → object) | yes |  |

### EventScheduleCreated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `schedule` | [Schedule](https://developers.processcart.com/reference/schemas#schedule) | yes |  |

### EventScheduleDeleted
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `schedule` | [Schedule](https://developers.processcart.com/reference/schemas#schedule) | yes |  |

### EventScheduleRunCreated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `schedule` | object | yes |  |

### EventScheduleUpdated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `schedule` | [Schedule](https://developers.processcart.com/reference/schemas#schedule) | yes |  |
| `change` | `"settings"` \\| `"paused"` \\| `"resumed"` \\| `"auto_disabled"` | yes |  |

### EventTaskAssigned
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |
| `assignees` | [ResolvedAssignee](https://developers.processcart.com/reference/schemas#resolvedassignee)[] | yes |  |

### EventTaskCompleted
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |

### EventTaskReady
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |

### EventTaskUncompleted
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |
| `task` | [RunTask](https://developers.processcart.com/reference/schemas#runtask) | yes |  |
| `byApproval` | [Key](https://developers.processcart.com/reference/schemas#key) | no |  |

### EventType
Open enum: new values may be added without a version bump — treat an unknown value as such.

Type: `"run.created"` \| `"run.updated"` \| `"run.status_changed"` \| `"run.completed"` \| `"run.trashed"` \| `"run.restored"` \| `"task.ready"` \| `"task.assigned"` \| …

### EventWebhookCreated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `webhook` | [Webhook](https://developers.processcart.com/reference/schemas#webhook) | yes |  |

### EventWebhookDeleted
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `webhook` | [Webhook](https://developers.processcart.com/reference/schemas#webhook) | yes |  |

### EventWebhookTest
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `webhook` | object | yes |  |

### EventWebhookUpdated
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `webhook` | [Webhook](https://developers.processcart.com/reference/schemas#webhook) | yes |  |
| `change` | `"settings"` \\| `"enabled"` \\| `"disabled"` \\| `"secret_rotated"` \\| `"auto_disabled"` | yes |  |

### EventWorkflowPublished
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `workflow` | object | yes |  |
| `version` | object | yes |  |

### ExportRunsCsvResponse
The CSV text: a header row, then one row per run (UTF-8, BOM, CRLF).

Type: string

### FieldKey
Type: string

### FieldOptions
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `choices` | string[] | no |  |
| `items` | object[] | no |  |
| `allRequired` | boolean | no |  |
| `multiple` | boolean | no |  |

### FieldsWrite
Type: object (key → [FieldWriteValue](https://developers.processcart.com/reference/schemas#fieldwritevalue))

### FieldType
Open enum: new values may be added without a version bump — treat an unknown value as such.

Type: `"text"` \| `"textarea"` \| `"number"` \| `"date"` \| `"time"` \| `"dropdown"` \| `"multi_choice"` \| `"checkbox"` \| …

### FieldValidation
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `expr` | string | yes |  |
| `message` | string | no |  |

### FieldWriteValue
Type: string \| number \| boolean \| string[] \| null

### FinalizeRunFileBody
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `filename` | string | yes |  |
| `target` | object | yes |  |

### FinalizeRunFileResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `attachment` | [Attachment](https://developers.processcart.com/reference/schemas#attachment) | yes |  |
| `run` | [Run](https://developers.processcart.com/reference/schemas#run) | yes |  |

### FormatConfig
Type: object

### FormatType
Open enum: new values may be added without a version bump — treat an unknown value as such.

Type: `"none"` \| `"number"` \| `"currency"` \| `"percent"` \| `"date"` \| `"time"` \| `"phone"` \| `"email"` \| …

### Formula
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `mode` | `"spreadsheet"` \\| `"js"` | yes |  |
| `expr` | string | yes |  |

### GetWorkflowSchemaResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `workflowId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `versionId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `versionNumber` | integer | yes |  |
| `start` | object (key → any) | yes |  |
| `fields` | object (key → any) | yes |  |

### Group
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string | yes |  |
| `memberIds` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### GuestConfig
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `contextFieldKeys` | [Key](https://developers.processcart.com/reference/schemas#key)[] | no |  |

### Health
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | `"ok"` \\| `"degraded"` | yes |  |

### ImportReport
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | string[] | yes |  |
| `warnings` | string[] | yes |  |
| `counts` | object | yes |  |
| `clearedAssignments` | integer | yes |  |
| `flaggedEmails` | string[] | yes |  |

### Instant
Type: string (date-time)

### Key
Type: string

### LabelDetail
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes |  |
| `name` | string | yes |  |
| `color` | string | yes |  |

### ListGroupsResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [Group](https://developers.processcart.com/reference/schemas#group)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### ListRunActivityResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [ActivityItem](https://developers.processcart.com/reference/schemas#activityitem)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### ListRunCommentsResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [Comment](https://developers.processcart.com/reference/schemas#comment)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### ListRunFilesResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [Attachment](https://developers.processcart.com/reference/schemas#attachment)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### ListUsersResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [User](https://developers.processcart.com/reference/schemas#user)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### ListViewRunsResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [Run](https://developers.processcart.com/reference/schemas#run)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### ListViewsResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [View](https://developers.processcart.com/reference/schemas#view)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### ListWorkflowsResponse
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [WorkflowSummary](https://developers.processcart.com/reference/schemas#workflowsummary)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### Me
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `org` | object | yes |  |
| `key` | object | yes |  |
| `rateLimit` | object | yes |  |

### OnFocusPopulate
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `expr` | string | yes |  |

### Problem
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | yes |  |
| `title` | string | yes |  |
| `status` | integer | yes |  |
| `detail` | string | no |  |
| `code` | `"unauthorized"` \\| `"invalid_api_key"` \\| `"key_revoked"` \\| `"insufficient_scope"` \\| `"read_only_key"` \\| `"not_allowed_for_key"` \\| `"rate_limited"` \\| `"idempotency_key_reused"` \\| … | yes | Open enum: new values may be added without a version bump — treat an unknown value as such. |
| `requestId` | string | yes |  |
| `errors` | object[] | no |  |
| `currentRevision` | integer | no | Only on a 409 `revision_mismatch`: the run's current revision. Read the run again, merge, and retry with `Expected-Revision: <currentRevision>`. |

### ProblemFieldError
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `field` | string | yes |  |
| `code` | string | yes |  |
| `message` | string | yes |  |

### Recurrence
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `freq` | `"daily"` \\| `"weekly"` \\| `"monthly"` \\| `"yearly"` | yes |  |
| `interval` | integer | yes |  |
| `time` | string | yes |  |
| `startDate` | [CalendarDate](https://developers.processcart.com/reference/schemas#calendardate) | yes |  |
| `endDate` | [CalendarDate](https://developers.processcart.com/reference/schemas#calendardate) \\| null | no |  |
| `weekly` | object | no |  |
| `monthly` | object | no |  |
| `yearly` | object | no |  |

### RequestRunFileBody
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `filename` | string | yes | The display name. Send the SAME string again at finalize. |
| `size` | integer | yes | The byte size (at most 26214400 — 25 MB). |
| `contentType` | string | yes | The MIME type you will send as the PUT's Content-Type — it becomes the stored type (echoed in `upload.headers`). |
| `target` | object | yes |  |

### ResolvedAssignee
Type: object

### RichDoc
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | `"doc"` | yes |  |
| `content` | [RichNode](https://developers.processcart.com/reference/schemas#richnode)[] | no |  |

### RichNode
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | yes |  |
| `attrs` | object (key → any) | no |  |
| `content` | [RichNode](https://developers.processcart.com/reference/schemas#richnode)[] | no |  |
| `marks` | object[] | no |  |
| `text` | string | no |  |

### RuleAction
Type: object

### RuleConditions
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `combinator` | `"and"` \\| `"or"` | yes |  |
| `items` | object[] | yes |  |

### RuleDef
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `effect` | `"show"` \\| `"hide"` | yes |  |
| `when` | object | yes |  |
| `targets` | object[] | yes |  |

### RuleExecution
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `ruleId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `runId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `run` | object \\| null | yes |  |
| `eventId` | string | yes |  |
| `eventType` | string | yes |  |
| `status` | `"queued"` \\| `"running"` \\| `"done"` \\| `"failed"` | yes |  |
| `result` | object[] | yes |  |
| `error` | string \\| null | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `startedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `finishedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |

### RuleExecutionList
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [RuleExecution](https://developers.processcart.com/reference/schemas#ruleexecution)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### RuleFilter
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `taskKey` | [Key](https://developers.processcart.com/reference/schemas#key) | no |  |
| `fieldKey` | [FieldKey](https://developers.processcart.com/reference/schemas#fieldkey) | no |  |

### Run
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string | yes |  |
| `status` | [RunStatus](https://developers.processcart.com/reference/schemas#runstatus) | yes |  |
| `priority` | [RunPriority](https://developers.processcart.com/reference/schemas#runpriority) | yes |  |
| `labels` | string[] | yes |  |
| `labelDetails` | [LabelDetail](https://developers.processcart.com/reference/schemas#labeldetail)[] | yes |  |
| `dueAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `keyDate` | [CalendarDate](https://developers.processcart.com/reference/schemas#calendardate) \\| null | yes |  |
| `revision` | integer | yes |  |
| `updatedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `startedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `startedBy` | [RunStartedSource](https://developers.processcart.com/reference/schemas#runstartedsource) | yes |  |
| `startedByUserId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `schedule` | object \\| null | yes |  |
| `scheduledFor` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `completedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `deletedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `workflow` | object | yes |  |
| `versionId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `url` | string (uri) | yes |  |
| `tasks` | [RunTask](https://developers.processcart.com/reference/schemas#runtask)[] | yes |  |
| `fields` | [RunField](https://developers.processcart.com/reference/schemas#runfield)[] | yes |  |

### RunField
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `key` | [FieldKey](https://developers.processcart.com/reference/schemas#fieldkey) | yes |  |
| `label` | string | yes |  |
| `type` | [FieldType](https://developers.processcart.com/reference/schemas#fieldtype) | yes |  |
| `format` | [FormatType](https://developers.processcart.com/reference/schemas#formattype) \\| null | yes |  |
| `taskKey` | [Key](https://developers.processcart.com/reference/schemas#key) | yes |  |
| `value` | [CanonicalValue](https://developers.processcart.com/reference/schemas#canonicalvalue) \\| null | yes |  |
| `formatted` | string | yes |  |
| `visible` | boolean | yes |  |
| `choices` | string[] | no |  |
| `items` | object[] | no |  |
| `validationError` | string | no |  |

### RunList
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [Run](https://developers.processcart.com/reference/schemas#run)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### RunLite
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string | yes |  |
| `revision` | integer | yes |  |
| `workflow` | object | yes |  |
| `deletedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |

### RunPatch
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no |  |
| `priority` | [RunPriority](https://developers.processcart.com/reference/schemas#runpriority) | no |  |
| `labels` | string[] | no |  |
| `dueAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| [CalendarDate](https://developers.processcart.com/reference/schemas#calendardate) \\| null | no |  |
| `status` | [RunStatus](https://developers.processcart.com/reference/schemas#runstatus) | no |  |

### RunPriority
Open enum: new values may be added without a version bump — treat an unknown value as such.

Type: `"none"` \| `"low"` \| `"medium"` \| `"high"` \| `"urgent"`

### RunsQuery
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `workflowId` | string (uuid) \\| null | yes |  |
| `status` | `"active"` \\| `"completed"` \\| `"on_hold"` \\| `"archived"`[] | yes |  |
| `priority` | `"none"` \\| `"low"` \\| `"medium"` \\| `"high"` \\| `"urgent"`[] | yes |  |
| `labels` | string[] | yes |  |
| `assignee` | object \\| null | yes |  |
| `due` | `"overdue"` \\| `"today"` \\| `"week"` \\| `"none"` \\| null | yes |  |
| `q` | string | yes |  |
| `qMode` | `"prefix"` \\| `"contains"` | no |  |
| `sort` | object | yes |  |
| `columns` | `"workflow"` \\| `"status"` \\| `"priority"` \\| `"progress"` \\| `"key_date"` \\| `"due"` \\| `"assignees"` \\| `"started"` \\| …[] | yes |  |

### RunStart
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `workflowId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string | yes |  |
| `fields` | [FieldsWrite](https://developers.processcart.com/reference/schemas#fieldswrite) | no |  |
| `priority` | [RunPriority](https://developers.processcart.com/reference/schemas#runpriority) | no |  |
| `labels` | string[] | no |  |
| `dueAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| [CalendarDate](https://developers.processcart.com/reference/schemas#calendardate) \\| null | no |  |

### RunStartedSource
Type: `"manual"` \| `"schedule"` \| `"api"` \| `"kickoff"`

### RunStatus
Open enum: new values may be added without a version bump — treat an unknown value as such.

Type: `"active"` \| `"completed"` \| `"on_hold"` \| `"archived"`

### RunTask
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `key` | [Key](https://developers.processcart.com/reference/schemas#key) | yes |  |
| `title` | string | yes |  |
| `kind` | [TaskKind](https://developers.processcart.com/reference/schemas#taskkind) | yes |  |
| `section` | string | yes |  |
| `state` | [RunTaskState](https://developers.processcart.com/reference/schemas#runtaskstate) | yes |  |
| `visible` | boolean | yes |  |
| `locked` | boolean | yes |  |
| `dueAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `assignees` | [ResolvedAssignee](https://developers.processcart.com/reference/schemas#resolvedassignee)[] | yes |  |
| `completedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `completedByUserId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |

### RunTaskList
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [RunTask](https://developers.processcart.com/reference/schemas#runtask)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### RunTaskState
Open enum: new values may be added without a version bump — treat an unknown value as such.

Type: `"todo"` \| `"done"` \| `"rejected_redo"`

### Schedule
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `workflowId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `workflow` | object | yes |  |
| `name` | string | yes |  |
| `description` | string | yes |  |
| `recurrence` | object | yes |  |
| `timezone` | string | yes |  |
| `namePattern` | string | yes |  |
| `presetValues` | object (key → [CanonicalValue](https://developers.processcart.com/reference/schemas#canonicalvalue)) | yes |  |
| `assignmentOverrides` | object (key → object[]) | yes |  |
| `enabled` | boolean | yes |  |
| `disabledReason` | `"manual"` \\| `"ended"` \\| `"unpublished"` \\| `"failed"` \\| `"workflow_trashed"` \\| `"workflow_archived"` \\| null | yes |  |
| `lastError` | string \\| null | yes |  |
| `consecutiveFailures` | integer | yes |  |
| `nextRunAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `nextOccurrences` | [Instant](https://developers.processcart.com/reference/schemas#instant)[] | yes |  |
| `lastRunAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `latestRun` | object \\| null | yes |  |
| `presetMismatches` | object[] | yes |  |
| `createdBy` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `updatedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### ScheduleConfig
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `workflowId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string | yes |  |
| `recurrence` | [Recurrence](https://developers.processcart.com/reference/schemas#recurrence) | yes |  |
| `timezone` | string | no |  |
| `namePattern` | string | no |  |
| `presetValues` | object (key → [CanonicalValue](https://developers.processcart.com/reference/schemas#canonicalvalue)) | no |  |
| `assignmentOverrides` | object (key → [AutomationAssignee](https://developers.processcart.com/reference/schemas#automationassignee)[]) | no |  |

### ScheduleList
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [Schedule](https://developers.processcart.com/reference/schemas#schedule)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### ScheduleOccurrences
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `occurrences` | [Instant](https://developers.processcart.com/reference/schemas#instant)[] | yes |  |

### SchedulePatch
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no |  |
| `recurrence` | [Recurrence](https://developers.processcart.com/reference/schemas#recurrence) | no |  |
| `timezone` | string | no |  |
| `namePattern` | string | no |  |
| `presetValues` | object (key → [CanonicalValue](https://developers.processcart.com/reference/schemas#canonicalvalue)) | no |  |
| `assignmentOverrides` | object (key → [AutomationAssignee](https://developers.processcart.com/reference/schemas#automationassignee)[]) | no |  |

### TaskDecision
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `comment` | string | no |  |

### TaskKind
Open enum: new values may be added without a version bump — treat an unknown value as such.

Type: `"standard"` \| `"approval"` \| `"email"`

### UpdateViewBody
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no |  |
| `query` | object | no | Changes to the view's board query. Send only the members you change; the rest keep the view's stored values (`null` clears `workflowId`, `assignee` or `due`). `sort.key` without `dir` takes that key's natural direction. An unknown member is a 422. |
| `visibility` | `"org"` \\| `"groups"` | no |  |
| `groupIds` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] | no |  |

### UpdateWorkflowBody
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no |  |
| `description` | string \\| null | no |  |
| `folderId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | no |  |
| `keyDateFieldKey` | [FieldKey](https://developers.processcart.com/reference/schemas#fieldkey) \\| null | no |  |
| `status` | `"active"` \\| `"archived"` | no |  |

### UploadTicket
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `attachmentId` | string (uuid) | yes | The id the attachment will have once finalized. |
| `upload` | object | yes |  |
| `finalize` | object | yes |  |

### User
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string \\| null | yes |  |
| `role` | `"member"` \\| `"builder"` \\| `"admin"` | yes |  |
| `avatarUrl` | string \\| null | yes |  |
| `joinedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### Uuid
Type: string (uuid)

### View
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string | yes |  |
| `query` | [RunsQuery](https://developers.processcart.com/reference/schemas#runsquery) | yes |  |
| `visibility` | `"org"` \\| `"groups"` | yes |  |
| `groupIds` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] | yes |  |
| `owner` | object \\| null | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `updatedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### Visibility
Type: `"visible"` \| `"hidden"`

### Webhook
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `url` | string | yes |  |
| `description` | string | yes |  |
| `events` | string[] | yes |  |
| `workflowIds` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] \\| null | yes |  |
| `filters` | object | yes |  |
| `enabled` | boolean | yes |  |
| `disabledReason` | `"failures"` \\| `"gone"` \\| `"manual"` \\| null | yes |  |
| `disabledAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `consecutiveFailures` | integer | yes |  |
| `lastDeliveryAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `createdBy` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `updatedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### WebhookConfig
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | yes |  |
| `description` | string | no |  |
| `events` | [EventType](https://developers.processcart.com/reference/schemas#eventtype) \\| `"*"`[] | yes |  |
| `workflowIds` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] \\| null | no |  |
| `filters` | object | no |  |

### WebhookDelivery
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `webhookId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `eventId` | string | yes |  |
| `eventType` | string | yes |  |
| `status` | `"pending"` \\| `"delivered"` \\| `"failed"` \\| `"exhausted"` | yes |  |
| `attemptCount` | integer | yes |  |
| `lastStatusCode` | integer \\| null | yes |  |
| `lastError` | string \\| null | yes |  |
| `lastAttemptAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `nextAttemptAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `deliveredAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### WebhookDeliveryList
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [WebhookDelivery](https://developers.processcart.com/reference/schemas#webhookdelivery)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### WebhookDeliveryWithPayload
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `webhookId` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `eventId` | string | yes |  |
| `eventType` | string | yes |  |
| `status` | `"pending"` \\| `"delivered"` \\| `"failed"` \\| `"exhausted"` | yes |  |
| `attemptCount` | integer | yes |  |
| `lastStatusCode` | integer \\| null | yes |  |
| `lastError` | string \\| null | yes |  |
| `lastAttemptAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `nextAttemptAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `deliveredAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `payload` | [EventEnvelope](https://developers.processcart.com/reference/schemas#eventenvelope) | yes |  |

### WebhookList
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | [Webhook](https://developers.processcart.com/reference/schemas#webhook)[] | yes |  |
| `nextCursor` | string \\| null | yes |  |
| `hasMore` | boolean | yes |  |

### WebhookPatch
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | no |  |
| `description` | string | no |  |
| `events` | [EventType](https://developers.processcart.com/reference/schemas#eventtype) \\| `"*"`[] | no |  |
| `workflowIds` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] \\| null | no |  |
| `filters` | object | no |  |

### WebhookQueuedDelivery
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `delivery` | object | yes |  |

### WebhookSecret
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `secret` | string | yes |  |
| `previousExpiresAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### WebhookWithSecret
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `url` | string | yes |  |
| `description` | string | yes |  |
| `events` | string[] | yes |  |
| `workflowIds` | [Uuid](https://developers.processcart.com/reference/schemas#uuid)[] \\| null | yes |  |
| `filters` | object | yes |  |
| `enabled` | boolean | yes |  |
| `disabledReason` | `"failures"` \\| `"gone"` \\| `"manual"` \\| null | yes |  |
| `disabledAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `consecutiveFailures` | integer | yes |  |
| `lastDeliveryAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) \\| null | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `createdBy` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) \\| null | yes |  |
| `updatedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `secret` | string | yes |  |

### WorkflowDetail
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string | yes |  |
| `description` | string \\| null | yes |  |
| `status` | `"active"` \\| `"archived"` | yes |  |
| `icon` | string \\| null | yes |  |
| `color` | string \\| null | yes |  |
| `folder` | object \\| null | yes |  |
| `keyDateFieldKey` | string \\| null | yes |  |
| `kickoffFormEnabled` | boolean | yes |  |
| `publishedVersion` | object \\| null | yes |  |
| `taskCount` | integer | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `updatedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `sections` | [WorkflowSection](https://developers.processcart.com/reference/schemas#workflowsection)[] | yes |  |
| `rules` | [RuleDef](https://developers.processcart.com/reference/schemas#ruledef)[] | yes |  |

### WorkflowField
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `key` | [FieldKey](https://developers.processcart.com/reference/schemas#fieldkey) | yes |  |
| `type` | [FieldType](https://developers.processcart.com/reference/schemas#fieldtype) | yes |  |
| `label` | string | yes |  |
| `help` | string \\| null | yes |  |
| `required` | boolean | yes |  |
| `defaultVisibility` | [Visibility](https://developers.processcart.com/reference/schemas#visibility) | yes |  |
| `options` | [FieldOptions](https://developers.processcart.com/reference/schemas#fieldoptions) \\| null | yes |  |
| `formatConfig` | [FormatConfig](https://developers.processcart.com/reference/schemas#formatconfig) \\| null | yes |  |
| `validation` | [FieldValidation](https://developers.processcart.com/reference/schemas#fieldvalidation) \\| null | yes |  |
| `defaultValue` | object \\| null | yes |  |
| `onFocusPopulate` | [OnFocusPopulate](https://developers.processcart.com/reference/schemas#onfocuspopulate) \\| null | yes |  |
| `formula` | [Formula](https://developers.processcart.com/reference/schemas#formula) \\| null | yes |  |
| `inKickoff` | boolean | yes |  |
| `kickoffPosition` | integer \\| null | yes |  |
| `readOnly` | boolean | yes |  |

### WorkflowSection
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `key` | [Key](https://developers.processcart.com/reference/schemas#key) | yes |  |
| `title` | string | yes |  |
| `defaultVisibility` | [Visibility](https://developers.processcart.com/reference/schemas#visibility) | yes |  |
| `tasks` | [WorkflowTask](https://developers.processcart.com/reference/schemas#workflowtask)[] | yes |  |

### WorkflowSummary
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | [Uuid](https://developers.processcart.com/reference/schemas#uuid) | yes |  |
| `name` | string | yes |  |
| `description` | string \\| null | yes |  |
| `status` | `"active"` \\| `"archived"` | yes |  |
| `icon` | string \\| null | yes |  |
| `color` | string \\| null | yes |  |
| `folder` | object \\| null | yes |  |
| `keyDateFieldKey` | string \\| null | yes |  |
| `kickoffFormEnabled` | boolean | yes |  |
| `publishedVersion` | object \\| null | yes |  |
| `taskCount` | integer | yes |  |
| `createdAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |
| `updatedAt` | [Instant](https://developers.processcart.com/reference/schemas#instant) | yes |  |

### WorkflowTask
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `key` | [Key](https://developers.processcart.com/reference/schemas#key) | yes |  |
| `title` | string | yes |  |
| `kind` | [TaskKind](https://developers.processcart.com/reference/schemas#taskkind) | yes |  |
| `isStop` | boolean | yes |  |
| `defaultVisibility` | [Visibility](https://developers.processcart.com/reference/schemas#visibility) | yes |  |
| `dueRule` | [DueRule](https://developers.processcart.com/reference/schemas#duerule) \\| null | yes |  |
| `assignment` | [Assignment](https://developers.processcart.com/reference/schemas#assignment) \\| null | yes |  |
| `guestConfig` | [GuestConfig](https://developers.processcart.com/reference/schemas#guestconfig) \\| null | yes |  |
| `fields` | [WorkflowField](https://developers.processcart.com/reference/schemas#workflowfield)[] | yes |  |

### WorkflowTemplate
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `formatVersion` | integer | yes |  |
| `engineVersion` | integer | yes |  |
| `exportedAt` | string (date-time) \\| null | no |  |
| `source` | string \\| null | no |  |
| `workflow` | object | yes |  |