Process CartAPI

Schemas

Every component schema of the OpenAPI document with its properties.

View this page as Markdown

Every component schema of the OpenAPI document, 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 yes
runId Uuid yes
type string yes
category "fields" \ "tasks" \ "approvals" \
actor EventActor yes
taskKey string \ null yes
payload object (key → any) yes
description string yes
createdAt 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 yes
runId Uuid yes
taskKey string \ null yes
fieldKey string \ null yes
commentId Uuid \ null yes
filename string yes
size integer yes
contentType string yes
uploadedByUserId Uuid \ null yes
uploadedBy Actor yes
createdAt Instant yes
downloadUrl string (uri) no A signed download link (Content-Disposition: attachment), valid one hour.
downloadExpiresAt Instant no

AutomationAssignee

Type: object

AutomationRule

Property Type Required Description
id Uuid yes
workflowId Uuid \ null yes
workflow object \ null yes
name string yes
triggerEvent "run.created" \ "run.updated" \ "run.status_changed" \
filter object yes
conditions object yes
actions object[] yes
enabled boolean yes
disabledReason "manual" \ "failures" \ "loop_guard" \
disabledAt Instant \ null yes
consecutiveFailures integer yes
keyMismatches object[] yes
createdBy Uuid \ null yes
createdAt Instant yes
updatedAt Instant yes

AutomationRuleConfig

Property Type Required Description
name string yes
workflowId Uuid \ null yes
triggerEvent "run.created" \ "run.updated" \ "run.status_changed" \
filter RuleFilter no
conditions RuleConditions no
actions RuleAction[] yes

AutomationRuleList

Property Type Required Description
data AutomationRule[] yes
nextCursor string \ null yes
hasMore boolean yes

AutomationRulePatch

Property Type Required Description
name string no
workflowId Uuid \ null no
triggerEvent "run.created" \ "run.updated" \ "run.status_changed" \
filter RuleFilter no
conditions RuleConditions no
actions RuleAction[] no

CalendarDate

Type: string

CanonicalValue

Type: string | number | boolean | string[]

Comment

Property Type Required Description
id Uuid yes
runId Uuid yes
taskKey Key yes
runTaskId Uuid yes
author 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[] yes
createdAt Instant yes
editedAt 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[] no

CreateWorkflowBody

Property Type Required Description
template WorkflowTemplate yes
name string no
description string \ null no
folderId Uuid \ null no
publish boolean no

CreateWorkflowResponse

Property Type Required Description
id 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 yes
updatedAt Instant yes
sections WorkflowSection[] yes
rules RuleDef[] yes
import 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 yes
decision "approved" \ "rejected" yes
comment string \ null yes
decidedBy Uuid \ null yes
decidedByEmail string \ null yes
decidedAt Instant yes

EventApprovalDecided

Property Type Required Description
run Run yes
task RunTask yes
approval EventApproval yes

EventApprovalRequested

Property Type Required Description
run Run yes
task RunTask yes

EventAttachment

Property Type Required Description
id Uuid yes
filename string yes
size integer yes
mime string yes
fieldKey string \ null yes
taskKey string yes
commentId Uuid \ null yes

EventAttachmentCreated

Property Type Required Description
run Run yes
task RunTask yes
attachment EventAttachment yes

EventComment

Property Type Required Description
id Uuid yes
authorId Uuid \ null yes
text string yes
mentions Uuid[] yes

EventCommentCreated

Property Type Required Description
run Run yes
task RunTask yes
comment EventComment yes

EventEnvelope

Property Type Required Description
id string yes
type EventType yes
timestamp string yes
org object yes
actor EventActor yes
data object (key → any) yes

EventField

Property Type Required Description
key FieldKey yes
label string yes
type FieldType yes
format FormatType \ null yes
taskKey Key yes
value CanonicalValue \ null yes
formatted string yes
visible boolean yes
choices string[] no
items object[] no
validationError string no
previous CanonicalValue \ null yes

EventFieldUpdated

Property Type Required Description
run Run yes
field EventField yes

EventGuest

Property Type Required Description
email string yes
linkId Uuid yes

EventGuestTaskCompleted

Property Type Required Description
run Run yes
task RunTask yes
guest EventGuest yes

EventGuestTaskViewed

Property Type Required Description
run Run yes
task RunTask yes
guest EventGuest yes

EventRuleCreated

Property Type Required Description
rule AutomationRule yes

EventRuleDeleted

Property Type Required Description
rule AutomationRule yes

EventRuleUpdated

Property Type Required Description
rule AutomationRule yes
change "settings" \ "enabled" \ "disabled" \

EventRunCompleted

Property Type Required Description
run Run yes

EventRunCreated

Property Type Required Description
run Run yes
kickoffLinkId Uuid no

EventRunRestored

Property Type Required Description
run Run \ RunLite yes
withWorkflow boolean no

EventRunStatusChanged

Property Type Required Description
run Run yes
changes object yes

EventRunTrashed

Property Type Required Description
run Run \ RunLite yes
withWorkflow boolean no

EventRunUpdated

Property Type Required Description
run Run yes
changes object (key → object) yes

EventScheduleCreated

Property Type Required Description
schedule Schedule yes

EventScheduleDeleted

Property Type Required Description
schedule Schedule yes

EventScheduleRunCreated

Property Type Required Description
run Run yes
schedule object yes

EventScheduleUpdated

Property Type Required Description
schedule Schedule yes
change "settings" \ "paused" \ "resumed" \

EventTaskAssigned

Property Type Required Description
run Run yes
task RunTask yes
assignees ResolvedAssignee[] yes

EventTaskCompleted

Property Type Required Description
run Run yes
task RunTask yes

EventTaskReady

Property Type Required Description
run Run yes
task RunTask yes

EventTaskUncompleted

Property Type Required Description
run Run yes
task RunTask yes
byApproval 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 yes

EventWebhookDeleted

Property Type Required Description
webhook Webhook yes

EventWebhookTest

Property Type Required Description
webhook object yes

EventWebhookUpdated

Property Type Required Description
webhook Webhook yes
change "settings" \ "enabled" \ "disabled" \

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)

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 yes
run 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 yes
versionId Uuid yes
versionNumber integer yes
start object (key → any) yes
fields object (key → any) yes

Group

Property Type Required Description
id Uuid yes
name string yes
memberIds Uuid[] yes
createdAt Instant yes

GuestConfig

Property Type Required Description
contextFieldKeys 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[] yes
nextCursor string \ null yes
hasMore boolean yes

ListRunActivityResponse

Property Type Required Description
data ActivityItem[] yes
nextCursor string \ null yes
hasMore boolean yes

ListRunCommentsResponse

Property Type Required Description
data Comment[] yes
nextCursor string \ null yes
hasMore boolean yes

ListRunFilesResponse

Property Type Required Description
data Attachment[] yes
nextCursor string \ null yes
hasMore boolean yes

ListUsersResponse

Property Type Required Description
data User[] yes
nextCursor string \ null yes
hasMore boolean yes

ListViewRunsResponse

Property Type Required Description
data Run[] yes
nextCursor string \ null yes
hasMore boolean yes

ListViewsResponse

Property Type Required Description
data View[] yes
nextCursor string \ null yes
hasMore boolean yes

ListWorkflowsResponse

Property Type Required Description
data 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" \
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" \
interval integer yes
time string yes
startDate CalendarDate yes
endDate 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[] no

RichNode

Property Type Required Description
type string yes
attrs object (key → any) no
content 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 yes
ruleId Uuid yes
runId Uuid yes
run object \ null yes
eventId string yes
eventType string yes
status "queued" \ "running" \ "done" \
result object[] yes
error string \ null yes
createdAt Instant yes
startedAt Instant \ null yes
finishedAt Instant \ null yes

RuleExecutionList

Property Type Required Description
data RuleExecution[] yes
nextCursor string \ null yes
hasMore boolean yes

RuleFilter

Property Type Required Description
taskKey Key no
fieldKey FieldKey no

Run

Property Type Required Description
id Uuid yes
name string yes
status RunStatus yes
priority RunPriority yes
labels string[] yes
labelDetails LabelDetail[] yes
dueAt Instant \ null yes
keyDate CalendarDate \ null yes
revision integer yes
updatedAt Instant yes
startedAt Instant yes
startedBy RunStartedSource yes
startedByUserId Uuid \ null yes
schedule object \ null yes
scheduledFor Instant \ null yes
completedAt Instant \ null yes
deletedAt Instant \ null yes
workflow object yes
versionId Uuid yes
url string (uri) yes
tasks RunTask[] yes
fields RunField[] yes

RunField

Property Type Required Description
key FieldKey yes
label string yes
type FieldType yes
format FormatType \ null yes
taskKey Key yes
value 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[] yes
nextCursor string \ null yes
hasMore boolean yes

RunLite

Property Type Required Description
id Uuid yes
name string yes
revision integer yes
workflow object yes
deletedAt Instant \ null yes

RunPatch

Property Type Required Description
name string no
priority RunPriority no
labels string[] no
dueAt Instant \ CalendarDate \ null
status 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" \
priority "none" \ "low" \ "medium" \
labels string[] yes
assignee object \ null yes
due "overdue" \ "today" \ "week" \
q string yes
qMode "prefix" \ "contains" no
sort object yes
columns "workflow" \ "status" \ "priority" \

RunStart

Property Type Required Description
workflowId Uuid yes
name string yes
fields FieldsWrite no
priority RunPriority no
labels string[] no
dueAt Instant \ CalendarDate \ null

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 yes
title string yes
kind TaskKind yes
section string yes
state RunTaskState yes
visible boolean yes
locked boolean yes
dueAt Instant \ null yes
assignees ResolvedAssignee[] yes
completedAt Instant \ null yes
completedByUserId Uuid \ null yes

RunTaskList

Property Type Required Description
data 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 yes
workflowId Uuid yes
workflow object yes
name string yes
description string yes
recurrence object yes
timezone string yes
namePattern string yes
presetValues object (key → CanonicalValue) yes
assignmentOverrides object (key → object[]) yes
enabled boolean yes
disabledReason "manual" \ "ended" \ "unpublished" \
lastError string \ null yes
consecutiveFailures integer yes
nextRunAt Instant \ null yes
nextOccurrences Instant[] yes
lastRunAt Instant \ null yes
latestRun object \ null yes
presetMismatches object[] yes
createdBy Uuid \ null yes
createdAt Instant yes
updatedAt Instant yes

ScheduleConfig

Property Type Required Description
workflowId Uuid yes
name string yes
recurrence Recurrence yes
timezone string no
namePattern string no
presetValues object (key → CanonicalValue) no
assignmentOverrides object (key → AutomationAssignee[]) no

ScheduleList

Property Type Required Description
data Schedule[] yes
nextCursor string \ null yes
hasMore boolean yes

ScheduleOccurrences

Property Type Required Description
occurrences Instant[] yes

SchedulePatch

Property Type Required Description
name string no
recurrence Recurrence no
timezone string no
namePattern string no
presetValues object (key → CanonicalValue) no
assignmentOverrides object (key → 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[] no

UpdateWorkflowBody

Property Type Required Description
name string no
description string \ null no
folderId Uuid \ null no
keyDateFieldKey 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 yes
name string \ null yes
role "member" \ "builder" \ "admin"
avatarUrl string \ null yes
joinedAt Instant yes

Uuid

Type: string (uuid)

View

Property Type Required Description
id Uuid yes
name string yes
query RunsQuery yes
visibility "org" \ "groups" yes
groupIds Uuid[] yes
owner object \ null yes
createdAt Instant yes
updatedAt Instant yes

Visibility

Type: "visible" | "hidden"

Webhook

Property Type Required Description
id Uuid yes
url string yes
description string yes
events string[] yes
workflowIds Uuid[] \ null yes
filters object yes
enabled boolean yes
disabledReason "failures" \ "gone" \ "manual" \
disabledAt Instant \ null yes
consecutiveFailures integer yes
lastDeliveryAt Instant \ null yes
createdAt Instant yes
createdBy Uuid \ null yes
updatedAt Instant yes

WebhookConfig

Property Type Required Description
url string yes
description string no
events EventType \ "*"[] yes
workflowIds Uuid[] \ null no
filters object no

WebhookDelivery

Property Type Required Description
id Uuid yes
webhookId Uuid yes
eventId string yes
eventType string yes
status "pending" \ "delivered" \ "failed" \
attemptCount integer yes
lastStatusCode integer \ null yes
lastError string \ null yes
lastAttemptAt Instant \ null yes
nextAttemptAt Instant \ null yes
deliveredAt Instant \ null yes
createdAt Instant yes

WebhookDeliveryList

Property Type Required Description
data WebhookDelivery[] yes
nextCursor string \ null yes
hasMore boolean yes

WebhookDeliveryWithPayload

Property Type Required Description
id Uuid yes
webhookId Uuid yes
eventId string yes
eventType string yes
status "pending" \ "delivered" \ "failed" \
attemptCount integer yes
lastStatusCode integer \ null yes
lastError string \ null yes
lastAttemptAt Instant \ null yes
nextAttemptAt Instant \ null yes
deliveredAt Instant \ null yes
createdAt Instant yes
payload EventEnvelope yes

WebhookList

Property Type Required Description
data Webhook[] yes
nextCursor string \ null yes
hasMore boolean yes

WebhookPatch

Property Type Required Description
url string no
description string no
events EventType \ "*"[] no
workflowIds Uuid[] \ null no
filters object no

WebhookQueuedDelivery

Property Type Required Description
delivery object yes

WebhookSecret

Property Type Required Description
secret string yes
previousExpiresAt Instant yes

WebhookWithSecret

Property Type Required Description
id Uuid yes
url string yes
description string yes
events string[] yes
workflowIds Uuid[] \ null yes
filters object yes
enabled boolean yes
disabledReason "failures" \ "gone" \ "manual" \
disabledAt Instant \ null yes
consecutiveFailures integer yes
lastDeliveryAt Instant \ null yes
createdAt Instant yes
createdBy Uuid \ null yes
updatedAt Instant yes
secret string yes

WorkflowDetail

Property Type Required Description
id 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 yes
updatedAt Instant yes
sections WorkflowSection[] yes
rules RuleDef[] yes

WorkflowField

Property Type Required Description
key FieldKey yes
type FieldType yes
label string yes
help string \ null yes
required boolean yes
defaultVisibility Visibility yes
options FieldOptions \ null yes
formatConfig FormatConfig \ null yes
validation FieldValidation \ null yes
defaultValue object \ null yes
onFocusPopulate OnFocusPopulate \ null yes
formula Formula \ null yes
inKickoff boolean yes
kickoffPosition integer \ null yes
readOnly boolean yes

WorkflowSection

Property Type Required Description
key Key yes
title string yes
defaultVisibility Visibility yes
tasks WorkflowTask[] yes

WorkflowSummary

Property Type Required Description
id 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 yes
updatedAt Instant yes

WorkflowTask

Property Type Required Description
key Key yes
title string yes
kind TaskKind yes
isStop boolean yes
defaultVisibility Visibility yes
dueRule DueRule \ null yes
assignment Assignment \ null yes
guestConfig GuestConfig \ null yes
fields 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