Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Approver Groups

List approver groups

Approver groups are the ordered tiers of approvers inside a single approval flow on a job or offer. Each group has its own approvals_required threshold (e.g., "any 1 of 3" or "all 4") and resolves as approved once that many of its members approve, or as rejected once enough members reject. Groups with a lower sort_order must resolve as approved before later groups become actionable. Filter to a specific flow with approval_flow_ids and look up the individual people in each group via /v3/approvers?approver_group_ids=. To restructure the tiers themselves, use PUT /v3/approval_flows/{id}/replace_approver_groups; to swap one person within a group, use PUT /v3/approver_groups/{id}/replace_approver.

get/v3/approver_groups

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
approval_flow_idsinteger[]

Return only the approver groups belonging to these approval flow IDs. Each approver group is a single step in its parent flow's approver chain. Use sort_order to order the steps within a flow.

fieldsstring[]

Comma separated list of fields to return

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
approval_flow_idinteger

Id of the approval flow this group belongs to.

approvals_requiredinteger

Number of approvers in this group whose approve actions are needed to resolve the group as approved (i.e., the M in "M of N"). Defaults to 1. The group resolves as rejected once enough approvers reject that the remaining members can no longer reach this threshold.

sort_orderinteger

Zero-based position of this group within its approval flow. Groups with the same sort_order resolve in parallel; groups with a higher sort_order only become actionable once all earlier groups have resolved as approved.

required_for_exceptionboolean

When true, this group must still approve even when the approval flow is being processed as an exception (where other groups can be skipped). Defaults to false.

resolved_atstring date-time nullable

ISO 8601 timestamp at which the group reached a terminal state (all approvals_required approvals received, or enough rejections to make that impossible). Null while the group is still pending.