---
title: "Pave API"
description: "Pave API"
canonical_url: "https://support.pave.com/articles/pave-api-VJt05vsHF3"
md_url: "https://support.pave.com/articles/pave-api-VJt05vsHF3.md"
---
# 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.