Skip to main content
GET
/
v1
/
compensations
List compensations
curl --request GET \
  --url https://api.plane.com/v1/compensations \
  --header 'Authorization: Bearer <token>'
{
  "compensations": [
    {
      "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

​
limit
number
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
​
worker
string
Only return compensations for this worker.
​
status
string
Only return compensations in this status, one of accepted, pending, or in_progress.
​
cursor
string
A value from a previous response that lets you fetch the next page.
​
starting_after
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
​
ending_before
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

​
Returns

A dictionary with a compensations property that contains an array of up to limit compensations, starting after compensation starting_after. Each entry in the array is a separate compensation object. If no more compensations are available, the resulting array will be empty. 
{
  "compensations": [
    {
      "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"
    },
    {...},
    {...}
  ]
}