# Pave External API

Documentation for the Pave External API

Version: 1.0

## Servers

Pave Production Server
```
https://api.pave.com
```

## Security

### api-key

API Key generated within the Pave App

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

[Pave External API](https://developers.pave.com/_bundle/apis/index.yaml)

## Ping API

### Test Endpoint

 - [GET /ping](https://developers.pave.com/apis/ping-api/pingcontroller_ping.md)

## Merit Cycle API

### List Merit Cycles

 - [GET /v1/compensationPlanning/meritCycles](https://developers.pave.com/apis/merit-cycle-api/meritcyclecontroller_findall_v1.md): Returns a list of all merit cycles

### Get a Merit Cycle by ID

 - [GET /v1/compensationPlanning/meritCycles/{id}](https://developers.pave.com/apis/merit-cycle-api/meritcyclecontroller_findbyid_v1.md): Returns a single Merit Cycle by ID

### Get Exchange Rates for a Merit Cycle

 - [GET /v1/compensationPlanning/meritCycles/{id}/exchangeRates](https://developers.pave.com/apis/merit-cycle-api/meritcyclecontroller_getexchangerates_v1.md): Returns exchange rates for a merit cycle, relative to the merit cycle currency

## Merit Cycle Employee API

### List Merit Cycle Employees

 - [GET /v1/compensationPlanning/meritCycles/{meritCycleId}/employees](https://developers.pave.com/apis/merit-cycle-employee-api/meritcycleemployeecontroller_findall_v1.md): Returns a list of all merit cycle employees