---
title: "Get an overview for a given user in an in-cycle comp-review"
method: GET
path: "/v1/org/{orgId}/comp-review/{compReviewId}/in-cycle"
tags: ["comp-review"]
---

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

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

## Request

- Base URL: `https://localhost`
- URL: `https://localhost/v1/org/{orgId}/comp-review/{compReviewId}/in-cycle`
- Auth: none declared

## Path parameters

- `orgId` string, required
- `compReviewId` string, required

## Query parameters

- `scenariosOnly` boolean
- `proposalOnly` boolean
- `reviewsOnly` boolean
- `columnsOnly` boolean
- `isPreview` boolean
- `jobId` string
- `includeAllRequests` boolean
- `includeFeatures` boolean

## Response `200`

successful operation

- InCycleViewResponse
  - `reviews` ApprovalRequestCompReviewResponse[]
    - `id` string, required
    - `status` 'CANCELED' | 'REJECTED' | 'PENDING' | 'ACTIVE' | 'REVIEWED' | 'APPROVED' | 'SKIPPED' | 'SUBMITTED', required
    - `parentStatus` 'CANCELED' | 'REJECTED' | 'PENDING' | 'ACTIVE' | 'REVIEWED' | 'APPROVED' | 'SKIPPED' | 'SUBMITTED'
    - `isFullySubmitted` boolean
    - `entityType` 'COMP_REVIEW' | 'SCENARIO' | 'TIMEOFF', required
    - `entityId` string, required
    - `approvalChainId` string, required
    - `stageOverrides` ApprovalChainStageOverride[], required
      - `stageOverrideId` string, required: unique id for stage
      - `approvalChainStageId` string, required: parent approval chain stage id
      - `groups` ApprovalGroup[]: approval group override
        - `groupId` string: globally unique id
        - `type` 'REVIEWER' | 'COLLABORATOR' | 'FINAL_APPROVER', required: What type of group this is
        - `approvers` ApprovalGroupApprover[], required: approvers that make up the group
          - `jobId` string, required: A job ID that is part of the group
          - `status` 'PENDING' | 'APPROVED' | 'REJECTED' | 'SKIPPED', required: The status of the approver
          - `commentId` string: Last comment of the approver
          - `reassignCommentId` string: Last comment associated with a reassignment
          - `isFallback` boolean: Whether approver is a fallback
          - `fallbackFor` string: What jobId approver is a fallback for
          - `actedByJobId` string: Job of the delegate who acted on this slot on the approver's behalf
          - `updateAt` string: The date the status was updated last
        - `expandExpression` string: optional custom expression to determine approval request tree
        - `minApproversNeeded` integer: minimum number of approvers required in this group for approval (null means all approvers required)
      - `status` 'CANCELED' | 'REJECTED' | 'PENDING' | 'ACTIVE' | 'REVIEWED' | 'APPROVED' | 'SKIPPED' | 'SUBMITTED', required: status of the stage
      - `order` integer, required: order of the stage
    - `createId` string
    - `createAt` string
    - `updateId` string
    - `updateAt` string
  - `proposal` ApprovalRequestCompReviewResponse
    - `id` string, required
    - `status` 'CANCELED' | 'REJECTED' | 'PENDING' | 'ACTIVE' | 'REVIEWED' | 'APPROVED' | 'SKIPPED' | 'SUBMITTED', required
    - `parentStatus` 'CANCELED' | 'REJECTED' | 'PENDING' | 'ACTIVE' | 'REVIEWED' | 'APPROVED' | 'SKIPPED' | 'SUBMITTED'
    - `isFullySubmitted` boolean
    - `entityType` 'COMP_REVIEW' | 'SCENARIO' | 'TIMEOFF', required
    - `entityId` string, required
    - `approvalChainId` string, required
    - `stageOverrides` ApprovalChainStageOverride[], required
      - `stageOverrideId` string, required: unique id for stage
      - `approvalChainStageId` string, required: parent approval chain stage id
      - `groups` ApprovalGroup[]: approval group override
        - `groupId` string: globally unique id
        - `type` 'REVIEWER' | 'COLLABORATOR' | 'FINAL_APPROVER', required: What type of group this is
        - `approvers` ApprovalGroupApprover[], required: approvers that make up the group
          - `jobId` string, required: A job ID that is part of the group
          - `status` 'PENDING' | 'APPROVED' | 'REJECTED' | 'SKIPPED', required: The status of the approver
          - `commentId` string: Last comment of the approver
          - `reassignCommentId` string: Last comment associated with a reassignment
          - `isFallback` boolean: Whether approver is a fallback
          - `fallbackFor` string: What jobId approver is a fallback for
          - `actedByJobId` string: Job of the delegate who acted on this slot on the approver's behalf
          - `updateAt` string: The date the status was updated last
        - `expandExpression` string: optional custom expression to determine approval request tree
        - `minApproversNeeded` integer: minimum number of approvers required in this group for approval (null means all approvers required)
      - `status` 'CANCELED' | 'REJECTED' | 'PENDING' | 'ACTIVE' | 'REVIEWED' | 'APPROVED' | 'SKIPPED' | 'SUBMITTED', required: status of the stage
      - `order` integer, required: order of the stage
    - `createId` string
    - `createAt` string
    - `updateId` string
    - `updateAt` string
  - `scenarioMap` object
  - `parentReviewsMap` object
  - `collaboratingWithJobIds` string[]
  - `visibleColumns` CompReviewWorkbookColumn[]
    - `name` string, required: field name
    - `label` string, required: display name in workbook
    - `color` string: color used in the column header
    - `editableFor` string, required: cql evaluated on the reviewee job specifying whether field is editable
    - `visibleTo` string, required: cql specifying who can view
    - `visibleToGroups` string[], required: list of groupIds with viewing permissions
    - `visibleToType` 'EVERYONE' | 'DEPARTMENT' | 'TEAM' | 'LOCATION' | 'CUSTOM', required: type of cql filter used in the visible to
    - `visibleToRoles` InCycleViewFeatures
      - `isFinalApprover` boolean, required
      - `isProposer` boolean, required
      - `isApprover` boolean, required
      - `isOwner` boolean, required
      - `isCollaborator` boolean, required
      - `isRoot` boolean
    - `editableForRoles` InCycleViewFeatures
      - `isFinalApprover` boolean, required
      - `isProposer` boolean, required
      - `isApprover` boolean, required
      - `isOwner` boolean, required
      - `isCollaborator` boolean, required
      - `isRoot` boolean
  - `error` object
  - `features` InCycleViewFeatures
    - `isFinalApprover` boolean, required
    - `isProposer` boolean, required
    - `isApprover` boolean, required
    - `isOwner` boolean, required
    - `isCollaborator` boolean, required
    - `isRoot` boolean
  - `canViewImpactDashboard` boolean

## Other responses

- `400`: bad request
- `401`: not authorized
- `404`: not found

---

[API](https://skmtc.dev/charthop/apis/charthop-api.md) - [All operations](https://skmtc.dev/charthop/apis/charthop-api/llms.txt) - [OpenAPI document](https://skmtc.dev/charthop/apis/charthop-api/revisions/e487d45ac256?raw)