Skip to main content
GET
https://api.plane.com/v1
/
payrolls
/
{id}
Get a payroll
curl --request GET \
  --url https://api.plane.com/v1/payrolls/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "prl_abc123def456",
  "type": "contractor",
  "status": "processed",
  "note": "January contractor payments",
  "period": {
    "starts": "2024-01-01",
    "ends": "2024-01-15"
  },
  "totals": {
    "amount": "25000.00",
    "currency": "USD"
  },
  "items": [
    {
      "worker": "wr_xyz789",
      "amount": "5000.00",
      "currency": "USD"
    },
    {
      "worker": "wr_abc123",
      "amount": "7500.00",
      "currency": "USD"
    },
    {
      "worker": "wr_def456",
      "amount": "12500.00",
      "currency": "USD"
    }
  ]
}

​
Parameters

​
id
string
required
The ID of a payroll object.
​
expand
string[]
Specifies which fields in the response should be expanded.

​
Returns

Returns a payroll if a valid identifier was provided, and returns an error otherwise. 
{
  "id": "prl_abc123def456",
  "type": "contractor",
  "status": "processed",
  "note": "January contractor payments",
  "period": {
    "starts": "2024-01-01",
    "ends": "2024-01-15"
  },
  "totals": {
    "amount": "25000.00",
    "currency": "USD"
  },
  "items": [
    {
      "worker": "wr_xyz789",
      "amount": "5000.00",
      "currency": "USD"
    },
    {
      "worker": "wr_abc123",
      "amount": "7500.00",
      "currency": "USD"
    },
    {
      "worker": "wr_def456",
      "amount": "12500.00",
      "currency": "USD"
    }
  ]
}