Sign in
comp-review

Return metadata for a particular comp review by ID

get/v1/org/{orgId}/comp-review/{compReviewId}/metadata

Path parameters

orgIdstring required

Org identifier (either id or slug)

compReviewIdstring required

Comp review id

Response

successful operation

compReviewIdstring required

comp review id

orgIdstring required

parent organization id (empty if built-in)

eligibleEmployeesinteger required

count of employees eligible for the comp review

eligibleEmployeesFilterstring required

filter to view eligible employees on the datasheet

ineligibleEmployeesinteger required

count of employees ineligible for the comp review

ineligibleEmployeesFilterstring required

filter to view ineligible employees on the datasheet

approversinteger required

count of final approvers

reviewersinteger required

count of reviewers in the comp review

collaboratorsinteger required

count of collaborators in the comp review

Example response

{
  "compReviewId": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7"
}

Changes

No recorded changes to this endpoint across all 11 revisions of this API.