CHcharthop
comp-review

Get a list of employees eligible for a given comp review

get/v1/org/{orgId}/comp-review/{compReviewId}/eligible-employees

Request

  • Base URL
    https://localhost
  • URL
    https://localhost/v1/org/{orgId}/comp-review/{compReviewId}/eligible-employees
  • Auth
    none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

compReviewIdstring required

Comp review id

Query parameters

filterScenarioIdsstring

Find ineligible employees under specific comp scenario managers

ineligibleboolean

Whether to get eligible or ineligible employees (defaults to eligible)

fromstring

Job id to start paginating from

limitinteger

Number of results to return

fieldsstring required

Table fields

formatstring

Data format to use; default is json, can also use json-extended or json-readable

filterstring

Optional CQL filter to apply to employees

Response

successful operation

dataobject[] required
nextstring
totalRowobject

Example response

{
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 30 revisions of this API.