v3

latestSwagger 2.02026-08-067506752.0 MB

comp-review

Get an overview for a given user in an in-cycle comp-review

get/v1/org/{orgId}/comp-review/{compReviewId}/in-cycle

Path parameters

orgIdstring required

Org identifier (either id or slug)

compReviewIdstring required

Comp review id

Query parameters

scenariosOnlyboolean

proposalOnlyboolean

reviewsOnlyboolean

columnsOnlyboolean

isPreviewboolean

jobIdstring

includeAllRequestsboolean

Allows users with multiple roles to request full access for owner or final approver roles

includeFeaturesboolean

Response

successful operation

scenarioMapobject

parentReviewsMapobject

collaboratingWithJobIdsstring[]

errorobject

Example response

{
  "reviews": [
    {
      "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"
    }
  ],
  "proposal": {
    "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"
  },
  "collaboratingWithJobIds": [
    "588f7ee98f138b19220041a7"
  ],
  "visibleColumns": [
    {
      "visibleToGroups": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}