Get a Merit Cycle by ID

Request

Returns a single Merit Cycle by ID

Security

api-key

Path

idstringrequired

The ID of the Merit Cycle

curl -i -X GET \
  'https://api.pave.com/v1/compensationPlanning/meritCycles/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Returns a Merit Cycle on success

Bodyapplication/json

idstringrequired

The ID of the Merit Cycle

Example:"mc_12345678-1234-5678-9012-123456789012"

namestringrequired

The name of the Merit Cycle

Example:"H1 Merit Cycle"

startDatestring, (date-time)required

The start date of the Merit Cycle

Example:"2025-01-01T00:00:00.000Z"

endDatestring, (date-time)required

The end date of the Merit Cycle

Example:"2025-01-31T00:00:00.000Z"

createdDatestring, (date-time)required

The date the Merit Cycle was created

Example:"2024-06-17T18:55:43.000Z"

statusstringrequired

The status of the Merit Cycle

Enum:"active""inactive""finalized"

Example:"active"

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