v1

latestOpenAPI 3.0.02026-08-065613.8 KB

Merit Cycle API

List Merit Cycles

Returns a list of all merit cycles

get/v1/compensationPlanning/meritCycles

Query parameters

status'active' | 'inactive' | 'finalized'

The status of the merit cycle

gtstring YYYY-MM-DD

Greater than the start date

gtestring YYYY-MM-DD

Greater than or equal to the start date

ltstring YYYY-MM-DD

Less than the start date

ltestring YYYY-MM-DD

Less than or equal to the start date

The start date of the merit cycle

{
  "gt": "2025-01-15",
  "gte": "2025-01-15",
  "lt": "2025-01-15",
  "lte": "2025-01-15"
}

limitnumber

The number of merit cycles to return

nextCursorstring

Example:eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ==

The next cursor to paginate through the list of merit cycles

Response

Returns a list of merit cycles on success

nextCursorstring

The next cursor to use for pagination

Example response

{
  "nextCursor": "eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ==",
  "data": [
    {
      "id": "mc_12345678-1234-5678-9012-123456789012",
      "name": "H1 Merit Cycle",
      "startDate": "2025-01-01T00:00:00.000Z",
      "endDate": "2025-01-31T00:00:00.000Z",
      "createdDate": "2024-06-17T18:55:43.000Z",
      "status": "active"
    }
  ]
}