Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
comp-review

Get a list of approval request responses for a given comp review

get/v1/org/{orgId}/comp-review/{compReviewId}/approval-requests

Path parameters

orgIdstring required

Org identifier (either id or slug)

compReviewIdstring required

Comp review id

Query parameters

isPreviewboolean

Response

successful operation

idstring required
status'CANCELED' | 'REJECTED' | 'PENDING' | 'ACTIVE' | 'REVIEWED' | 'APPROVED' | 'SKIPPED' | 'SUBMITTED' required
parentStatus'CANCELED' | 'REJECTED' | 'PENDING' | 'ACTIVE' | 'REVIEWED' | 'APPROVED' | 'SKIPPED' | 'SUBMITTED'
isFullySubmittedboolean
entityType'COMP_REVIEW' | 'SCENARIO' | 'TIMEOFF' required
entityIdstring required
approvalChainIdstring required
createIdstring
createAtstring
updateIdstring
updateAtstring

Example response

[
  {
    "id": "588f7ee98f138b19220041a7",
    "entityId": "588f7ee98f138b19220041a7",
    "approvalChainId": "588f7ee98f138b19220041a7",
    "stageOverrides": [
      {
        "stageOverrideId": "588f7ee98f138b19220041a7",
        "approvalChainStageId": "588f7ee98f138b19220041a7",
        "groups": [
          {
            "groupId": "588f7ee98f138b19220041a7",
            "approvers": [
              {
                "jobId": "588f7ee98f138b19220041a7",
                "commentId": "588f7ee98f138b19220041a7",
                "reassignCommentId": "588f7ee98f138b19220041a7",
                "fallbackFor": "588f7ee98f138b19220041a7",
                "actedByJobId": "588f7ee98f138b19220041a7"
              }
            ]
          }
        ]
      }
    ],
    "createId": "588f7ee98f138b19220041a7",
    "updateId": "588f7ee98f138b19220041a7"
  }
]