v1

latestOpenAPI 3.0.02026-08-065613.8 KB

Merit Cycle API

Get a Merit Cycle by ID

Returns a single Merit Cycle by ID

get/v1/compensationPlanning/meritCycles/{id}

Path parameters

idstring required

The ID of the Merit Cycle

Response

Returns a Merit Cycle on success

idstring required

The ID of the Merit Cycle

namestring required

The name of the Merit Cycle

startDatestring date-time required

The start date of the Merit Cycle

endDatestring date-time required

The end date of the Merit Cycle

createdDatestring date-time required

The date the Merit Cycle was created

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

The status of the Merit Cycle

Example response

{
  "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"
}