# Pave API

The Pave API lets you programmatically access compensation data from your Pave account. A common use case is pulling Compensation Planning cycle results back into your HRIS so compensation decisions flow directly into your system of record.

For full API documentation, including endpoints, request and response schemas, and code examples, visit [developers.pave.com](https://developers.pave.com).

## What the API offers

The API provides read access to Compensation Planning data:

* **Merit cycles**: Retrieve cycle details, status, and configuration
* **Employee compensation data**: Access employee-level compensation information within a merit cycle, including eligibility status, job details, and compensation values across currencies
* **Exchange rates**: Retrieve currency exchange rates associated with a merit cycle

All endpoints are read-only.

## Generate an API key

You create your API key from the **Connections** page:


1. Go to **Connections** and find the **Pave API** section.
2. Select **Generate key**.
3. Copy the API key from the modal.

The key is only shown once. If you lose it, you need to delete the existing key and generate a new one.

Your company can have one active API key at a time. To rotate your key, delete the current key and generate a new one.

## Permissions

To generate or delete an API key, your role must include edit access to the Pave API integration. By default, these roles have access: Admin, Manager, Integrator, and HRBP.

## Getting started

Visit [developers.pave.com](https://developers.pave.com) for setup instructions, endpoint reference, and integration guides.

Pave API

Connect ADP

Connect BambooHR

Connect Dayforce

Connect Deel

Connect Gusto

Connect HiBob

Connect Workday

Connect Namely

Connect Paylocity

Connect Personio

Connect Rippling

Connect UKG Pro

Connect CharlieHR

Connect Humaans

Connect Justworks

Connect Sapling

Connect SAP SuccessFactors

Connect TriNet

Connect Zenefits

HRIS Integrations

Connect Carta

Connect ComputerShare

Connect Shareworks

Connect E*Trade

Connect Fidelity

Connect Global Shares

Connect Pulley

Connect Schwab

Connect Ledgy

EMS integrations

Connect Culture Amp

Connect Workday Performance

Performance integrations

Connect Ashby

Connect Greenhouse

Connect Lever

Connect Workday ATS

ATS integrations

Manage your connections

Upload custom reports

Integrations

Team View Overview

Team View Column Configuration

Team View Customizations

Re-ordering Columns

Deleting Columns

Adding Columns

Team View Settings

Team View

Configurations overview

Cycle access permissions

Overview

Employee eligibility

Approval chains

Planning windows

Budgets

Recommendation logic

Adding non-integration data to your cycle

Reward letters

Cycle Setup

Columns

OTE planning

Writing formulas with Handlebars

Hourly and monthly pay

Columns and Formulas

Using the planner worksheet

Using the employee detail view

Cycle Progress dashboard

Budgets dashboard

Cycle Outcomes dashboard

Approval Statuses 

Worksheet Experience

Overview of smart features in compensation planning

Peer Comparison

Smart Flags

Priority Sort

Compensation Outliers

Manager Compression Flag

Vesting Drop Flag

Flags and Insights

Compensation Planning

How does Pave Work?

Intro to Pave

Contact Us

Pave 101

Getting Started

Grades

Setting up Company Job Architecture

Company Job Architecture

Job Architecture 101

Pay Zone Manager

Step 1: Build Foundation

Generate Bands from Market Data

Editing Bands

Calculated Columns

Bands Set Audit Log

Bulk & Manually Associate Market Data to Bands

Employee Distribution in Bands

How to duplicate band sets

Managing & Reordering Calculated Columns

Unmatched Employees

View changes

Pay Types: Calculated TDC, Annual Equity, and Refresh Equity

Manually Create New Band Sets

Band Sets

Upload/Download Bands

Step 3: Update Ranges

Advanced Filters

Compare Bands

Generate Bands for New Jobs in Your Job Architecture

Relative Permissions

Ongoing Management & Analysis

Edit and apply benchmarks

Set weights and logic

Map data sources to jobs

Supported survey providers

Manage Pave data sources

Manage survey data sources

Benchmarks overview

Survey aging

Step 2: Benchmarking

Market Pricing

Create an account and log in

Set up single sign-on (SSO)

Account setup

Configure role permissions

Create and manage roles

Roles and permissions

Impersonate a user

Manage notifications

Complete your company profile

Manage company settings

Platform settings

Account & Permissions

Create and manage Peer Groups in Market Data

Create and manage Market Data reports

Equity data benchmarking

Explore data composition

Explore the Pave job catalog

Filter Market Data benchmarks

Get started with Market Data

Share Market Data externally

Market Data Benchmarks (Features & Workflows)

Understand Calculated Benchmarks

Understand Consistency Labels

Understand job matching

Understand Market Data methodology

Understand job levels

Market Data Methodology 

Explore Global Location Insights

Explore Equity Practices

Other Pave Market Data Products 

Market Data FAQ

FAQ's

Upgrade to Market Data Pro

Upgrades & Pricing 

Market Data

Understanding Equity in Total Rewards

Display Original Grant Value

Compensation Simulator Configurations

Compensation Simulator Overview

Learning Hub Configuration

Learning Hub Overview

Reward Letters

Accessing your Total Rewards portal

Total Rewards 101

Visual Offer Letters with Workday

Visual Offer Letters with Greenhouse

Visual Offer Letters with Lever

Visual Offer Letter as a Candidate

Previewing Visual Offer Letters

Visual Offer Letters with Ashby

Creating and sending Visual Offer Letters in Pave

Visual Offer Letter 101

Why is my equity different in the equity tab on the left hand side compared to the equity valuation on the graphs?

Why can't I view my own Total Rewards portal?

Total Rewards and Visual Offer Letter FAQ

How can I complete our Greenhouse connection if "API credential management" is not in my Greenhouse menu?