List Merit Cycles

Request

Returns a list of all merit cycles

Security

api-key

Query

statusstring

The status of the merit cycle

Enum:"active""inactive""finalized"

startDateobject

The start date of the merit cycle

limitnumber, <= 100

The number of merit cycles to return

Default:25

nextCursorstring

The next cursor to paginate through the list of merit cycles

Example:nextCursor=eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ==

curl -i -X GET \
  'https://api.pave.com/v1/compensationPlanning/meritCycles?status=active&startDate=gt%3D2025-01-15%26gte%3D2025-01-15%26lt%3D2025-01-15%26lte%3D2025-01-15&limit=25&nextCursor=eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ%3D%3D' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Returns a list of merit cycles on success

Bodyapplication/json

nextCursorstring

The next cursor to use for pagination

Example:"eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ=="

dataArray of objects(MeritCycleResponseDto)

Response

{
  "data": [
    { … }
  ]
}