v1

latestOpenAPI 3.0.02026-08-065613.8 KB

Merit Cycle Employee API

List Merit Cycle Employees

Returns a list of all merit cycle employees

get/v1/compensationPlanning/meritCycles/{meritCycleId}/employees

Path parameters

meritCycleIdstring required

The ID of the Merit Cycle

Query parameters

limitnumber

The number of merit cycle employees to return

nextCursorstring

Example:eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ==

The next cursor to paginate through the list of merit cycle employees

Response

Returns a list of merit cycle employees on success

nextCursorstring

The next cursor to use for pagination

Example response

{
  "nextCursor": "eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ==",
  "data": [
    {
      "id": "mce_2312c64b-h5f1-46ca-8607-661a66319b91",
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "currencyCode": {
        "code": "USD",
        "value": "United States Dollar"
      },
      "eligibilityStatus": "eligible",
      "columns": {
        "department": {
          "name": "Department",
          "type": "text",
          "value": "Sales"
        },
        "employee": {
          "name": "Employee",
          "type": "composite",
          "value": {
            "fullName": "John Doe",
            "jobLevel": "P4",
            "jobTitle": "Sales Manager"
          }
        }
      }
    }
  ]
}