Overview

The Pave API enables you to programmatically access compensation data and integrate Pave with your existing tech stack. Connect your compensation planning data with analytics tools, HRIS systems, and business intelligence platforms to build a more unified compensation workflow.

What you can build

HRIS writeback: Automatically sync compensation changes to your HRIS after merit cycle completion. Eliminate manual data entry and reduce errors.
Analytics & reporting: Extract merit cycle data for advanced analysis in your BI tools. Create custom dashboards, track budget adherence, and generate executive reports.
Data quality automation: Build automated checks to ensure compensation data accuracy. Flag anomalies, validate business rules, and maintain data integrity.

Why use the Pave API?

Eliminate manual work: Automate repetitive tasks like data exports and HRIS updates
Real-time access: Get up-to-date compensation data whenever you need it
Custom workflows: Build integrations tailored to your organization's unique needs
Data consistency: Maintain a single source of truth across your compensation stack

API design principles

RESTful architecture

Our API follows REST principles with predictable resource-oriented URLs:

GET /v1/compensationPlanning/meritCycles          # List all cycles
GET /v1/compensationPlanning/meritCycles/{id}     # Get specific cycle
GET /v1/compensationPlanning/meritCycles/{id}/employees  # Get cycle employees

JSON responses

All responses return JSON with consistent structure:

{
  "data": [],
  "nextCursor": "kjs8SKJ989SUasckjkjsaU8ynjs" // when paginating
}

Idempotent & safe

GET requests are safe and idempotent
Use the same request multiple times without side effects

Need help?

See Use cases for implementation examples
Email support@pave.com for support