v3

latestSwagger 2.02026-08-067506752.0 MB

approval-request

Return a particular approval request scenario response by id

get/v1/org/{orgId}/approval-request/{approvalRequestId}/scenario-response

Path parameters

orgIdstring required

Org identifier (either id or slug)

approvalRequestIdstring required

Approval request id

Response

successful operation

idstring required

isCompleteboolean required

isApprovalCommentRequiredForActiveStageboolean required

isRejectionCommentRequiredForActiveStageboolean required

approvalChainIdstring required

scenarioIdstring required

createIdstring required

createAtstring required

updateIdstring required

updateAtstring required

deleteIdstring

deleteAtstring

delegatedApproverJobIdstring

delegatedApproverJobIdsstring[]

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "activeStage": {
    "stageOverrideId": "588f7ee98f138b19220041a7",
    "approvalChainStageId": "588f7ee98f138b19220041a7",
    "groups": [
      {
        "groupId": "588f7ee98f138b19220041a7",
        "approvers": [
          {
            "jobId": "588f7ee98f138b19220041a7",
            "commentId": "588f7ee98f138b19220041a7",
            "reassignCommentId": "588f7ee98f138b19220041a7",
            "fallbackFor": "588f7ee98f138b19220041a7",
            "actedByJobId": "588f7ee98f138b19220041a7"
          }
        ]
      }
    ]
  },
  "proposerStage": {
    "stageOverrideId": "588f7ee98f138b19220041a7",
    "approvalChainStageId": "588f7ee98f138b19220041a7",
    "groups": [
      {
        "groupId": "588f7ee98f138b19220041a7",
        "approvers": [
          {
            "jobId": "588f7ee98f138b19220041a7",
            "commentId": "588f7ee98f138b19220041a7",
            "reassignCommentId": "588f7ee98f138b19220041a7",
            "fallbackFor": "588f7ee98f138b19220041a7",
            "actedByJobId": "588f7ee98f138b19220041a7"
          }
        ]
      }
    ]
  },
  "nextReviewerStage": {
    "stageOverrideId": "588f7ee98f138b19220041a7",
    "approvalChainStageId": "588f7ee98f138b19220041a7",
    "groups": [
      {
        "groupId": "588f7ee98f138b19220041a7",
        "approvers": [
          {
            "jobId": "588f7ee98f138b19220041a7",
            "commentId": "588f7ee98f138b19220041a7",
            "reassignCommentId": "588f7ee98f138b19220041a7",
            "fallbackFor": "588f7ee98f138b19220041a7",
            "actedByJobId": "588f7ee98f138b19220041a7"
          }
        ]
      }
    ]
  },
  "rejectedStage": {
    "stageOverrideId": "588f7ee98f138b19220041a7",
    "approvalChainStageId": "588f7ee98f138b19220041a7",
    "groups": [
      {
        "groupId": "588f7ee98f138b19220041a7",
        "approvers": [
          {
            "jobId": "588f7ee98f138b19220041a7",
            "commentId": "588f7ee98f138b19220041a7",
            "reassignCommentId": "588f7ee98f138b19220041a7",
            "fallbackFor": "588f7ee98f138b19220041a7",
            "actedByJobId": "588f7ee98f138b19220041a7"
          }
        ]
      }
    ]
  },
  "stageOverrides": [
    {
      "stageOverrideId": "588f7ee98f138b19220041a7",
      "approvalChainStageId": "588f7ee98f138b19220041a7",
      "groups": [
        {
          "groupId": "588f7ee98f138b19220041a7",
          "approvers": [
            {
              "jobId": "588f7ee98f138b19220041a7",
              "commentId": "588f7ee98f138b19220041a7",
              "reassignCommentId": "588f7ee98f138b19220041a7",
              "fallbackFor": "588f7ee98f138b19220041a7",
              "actedByJobId": "588f7ee98f138b19220041a7"
            }
          ]
        }
      ]
    }
  ],
  "approvalChainId": "588f7ee98f138b19220041a7",
  "scenarioId": "588f7ee98f138b19220041a7",
  "createId": "588f7ee98f138b19220041a7",
  "updateId": "588f7ee98f138b19220041a7",
  "deleteId": "588f7ee98f138b19220041a7",
  "delegatedApproverJobId": "588f7ee98f138b19220041a7",
  "delegatedApproverJobIds": [
    "588f7ee98f138b19220041a7"
  ]
}