Magidoc

ApprovalStage
Object

An approval stage represents one step in an approval round where specific approvers must review and approve. Multiple stages execute sequentially within a round.

Fields

#

_id

ID !
Non-null

Unique identifier for the approval stage. Use this value as the stageId parameter in mutations like changeApprovalStageApprover.

actionId

ID !
Non-null

ID of the action this stage belongs to.

roundId

ID !
Non-null

ID of the approval round this stage belongs to.

name

String !
Non-null

Display name for this stage (e.g., "Design Review", "Legal Approval").

deleted

Boolean !
Non-null

Whether this stage has been soft-deleted.

deadline

Date

Optional deadline for this stage.

dueTime

Date

Optional due time for this stage.

startDate

Date

Timestamp when this stage was started (approval requested).

sortIndex

Int

Sort order of this stage within its round (0-based). This is NOT the stage ID - use the _id field for mutations.

approvals

[ApprovalItem !]!
Non-null

List of approval items (individual approvers) for this stage.

statusAfterApproval

StatusAfterApproval

Configuration for action status changes based on approval outcome.

approvalsCount

Int !
Non-null

Total number of approvals in this stage.

approvedApprovalsCount

Int !
Non-null

Number of approvals that have been granted.

approvalHistory

[ApprovalHistory !]!
Non-null

History of all approval status changes.

projectId

ID

ID of the project this stage belongs to (null if action has no project).

createdAt

Date !
Non-null

Timestamp when this stage was created.

createdBy

ID !
Non-null

User ID who created this stage.

Usages

#

References

#

  • Field nextApprovalStage from Query
  • Field changeApprovalStageApprover from Mutation