Approvals API

An approval request is one time a planning record was put up for approval: an epic, a story, a requirement, a business rule or a use case, a baseline or a change request, submitted by its author and decided by the approvers the project's policy names for that kind of approval. Submitting binds the request to the version of the record as it stood, moves the record into review where it has a review status, and tells the approvers. Each approver writes one signed verdict per round: approve, reject, or ask for changes. The policy's rule says how many approvals carry the request (any one, every approver, or a quorum); one rejection closes it and returns the record to where it stood; a request for changes holds it until the author edits the record and resubmits, which opens the next round. A request that carries stamps the record approved at the next version, bound to the revision that was reviewed.

Every policy sets clocks: the hours the approvers have, when the undecided ones are nudged, and when a request may carry by itself; the hourly sweep rings them, escalating an overdue request to the project's lead. A project that never changed a kind reads the defaults; the policy endpoint shows which.

Deciding is a person's act: the submit door is open to agents, the decide door is not. A client guest's token reads and decides only the requests that name them (through a stakeholder seat linked to their account) and submits nothing. Every write runs the same action the pages run and announces itself as an approval.* event; the move an approval makes on the record itself is announced by the record's own family (requirement.status_changed and its siblings).

EndpointsCopy Anchor Link

Related

Requirements API[Epics](/api/v1/reference/epics), [Work items](/api/v1/reference/work-items), [Business rules](/api/v1/reference/business-rules), [Use cases](/api/v1/reference/use-cases): the records an approval decides, with their versions.Stakeholders APIThe client seats a policy may name.approval.* eventsThe life of an approval request: an artefact put up for approval, each approver's verdict, the outcome the verdicts settle, a request taken back, a request that ran past its time, and a change to how a project decides a kind of approval.