Pave External API (1.0)

Documentation for the Pave External API

Download OpenAPI description

index.json

index.yaml

Servers

Pave Production Server

https://api.pave.com/

Ping API

Operations

Merit Cycle API

Operations

Merit Cycle Employee API

Operations

List Merit Cycle Employees

Request

Returns a list of all merit cycle employees

Security

api-key

Path

meritCycleIdstringrequired

The ID of the Merit Cycle

Query

limitnumber<= 100

The number of merit cycle employees to return

Default 25

nextCursorstring

The next cursor to paginate through the list of merit cycle employees

Example: nextCursor=eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ==

curl -i -X GET \
  'https://api.pave.com/v1/compensationPlanning/meritCycles/{meritCycleId}/employees?limit=25&nextCursor=eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ%3D%3D' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Returns a list of merit cycle employees on success

Bodyapplication/json

nextCursorstring

The next cursor to use for pagination

Example: "eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ=="

dataArray of objects(MeritCycleEmployeeResponseDto)

Response

application/json

{
  "data": [
    { … }
  ],
  "nextCursor": "eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ=="
}

Pave External API (1.0)

Ping API

Merit Cycle API

Merit Cycle Employee API

List Merit Cycle Employees

Request

Responses

Was this helpful?