Skip to main content
GET
/
v1
/
compensations
/
{id}
Get a compensation
curl --request GET \
  --url https://api.plane.com/v1/compensations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "wec_cNqYX2J3s9bI2Aa",
  "worker": "wr_5yMmVvd6Cz7Ptx",
  "type": "regular",
  "reason": null,
  "amount": "150000.00",
  "currency": "USD",
  "unit": "year",
  "frequency": "twice_monthly",
  "stock": null,
  "other": null,
  "starts": "2024-01-01",
  "ends": null,
  "created": "2024-01-01T00:00:00Z"
}

​
Parameters

​
id
string
required
The ID of a compensation in your Plane workspace.

​
Returns

Returns a compensation if a valid identifier was provided, and returns an error otherwise. 
{
  "id": "wec_cNqYX2J3s9bI2Aa",
  "worker": "wr_5yMmVvd6Cz7Ptx",
  "type": "regular",
  "reason": null,
  "amount": "150000.00",
  "currency": "USD",
  "unit": "year",
  "frequency": "twice_monthly",
  "stock": null,
  "other": null,
  "starts": "2024-01-01",
  "ends": null,
  "created": "2024-01-01T00:00:00Z"
}