Playground

Playground

ApprovalStep

/api/v1/approvals/steps

A step in an ApprovalRequest's chain.

listgetapprovereject

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
approval_request_iduuidUUID of the parent ApprovalRequest.
step_indexnumberZero-based position of this step in the approval chain.
approver_iduuidUUID of the Person assigned to decide on this step.
statusstringCurrent state of this step.
decisionstringThe approver's explicit decision. Null while the step is still pending.
commentstringOptional comment or justification left by the approver alongside their decision.
decided_atdate-timeISO 8601 timestamp when the approver made their decision. Null while still pending.
delegated_to_iduuidUUID of the Person this step was delegated to. Null unless status is 'delegated'.
request_iduuidParent approval request this step belongs to.
delegatedbooleanTrue once the step has been reassigned to another approver.

API

client.approvals.steps.*
Loading manifest…