Skip to content

Pave External API (1.0)

Documentation for the Pave External API

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Pave Production Server

https://api.pave.com/

Ping API

Operations

Merit Cycle API

Operations

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&gt=2025-01-15&gte=2025-01-15&lt=2025-01-15&lte=2025-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
application/json
{
  "data": [
    { … }
  ]
}

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
application/json
{
  "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"
}

Merit Cycle Employee API

Operations
© 2025 Trove Information Technologies, Inc. dba Pave