Skip to main content
GET
The steps of a held request, who each waits for, and whether it waits for the caller.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
workflow_instance_id
string
workflow_node_id
string
step_code
string
step_label
string
sort_order
string
status
string
opened_at
string
due_at
string
overdue
string
decided_at
string
decided_by_user_id
string
decided_by
string
decision_notes
string
skipped_reason
string
escalated_at
string
escalated_from_task_id
string
is_escalation
string
is_mine
string
can_be_satisfied
string
signatures_given
string
signatures_needed
string
signature_mode
string
signed_by
string
waiting_for
string
created_at
string
updated_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

can_be_satisfied
boolean<boolean>
created_at
string<timestamp with time zone>
decided_at
string<timestamp with time zone>
decided_by
string<character varying>
Maximum string length: 200
decided_by_user_id
string<uuid>

Note: This is a Foreign Key to my_profile.user_id.

decision_notes
string<text>
due_at
string<timestamp with time zone>
escalated_at
string<timestamp with time zone>
escalated_from_task_id
string<uuid>

Note: This is a Foreign Key to workflow_request_steps.id.

id
string<uuid>

Note: This is a Primary Key.

is_escalation
boolean<boolean>
is_mine
boolean<boolean>
opened_at
string<timestamp with time zone>
overdue
boolean<boolean>
signature_mode
string<text>
signatures_given
integer<integer>
signatures_needed
integer<integer>
signed_by
string<text>
skipped_reason
string<text>
sort_order
integer<integer>
status
string<character varying>
Maximum string length: 20
step_code
string<character varying>
Maximum string length: 60
step_label
string<character varying>
Maximum string length: 150
updated_at
string<timestamp with time zone>
waiting_for
string<text>
workflow_instance_id
string<uuid>

Note: This is a Foreign Key to workflow_requests.id.

workflow_node_id
string<uuid>

Note: This is a Foreign Key to workflow_nodes.id.