List payrolls
curl --request GET \
--url https://api.plane.com/v1/payrolls \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.plane.com/v1/payrolls"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.plane.com/v1/payrolls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plane.com/v1/payrolls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.plane.com/v1/payrolls"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.plane.com/v1/payrolls")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/payrolls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"payrolls": [
{
"id": "pr_26Nch2",
"entity": "ent_2gHL1F",
"type": "regular",
"status": "pending",
"note": null,
"fund_by": "2026-09-30",
"pay_schedule": "ps_baYVU",
"frequency": "biweekly",
"period": {
"starts": "2026-09-14",
"ends": "2026-09-27"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "4500.0",
"source_currency": "USD",
"destination_amount": "4500.0",
"destination_currency": "USD",
"hours": "80.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "344.25",
"source_currency": "USD",
"destination_amount": "344.25",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1019.25",
"source_currency": "USD",
"destination_amount": "1019.25",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "0.0",
"source_currency": "USD",
"destination_amount": "0.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "0.0",
"source_currency": "USD",
"destination_amount": "0.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "0.0",
"source_currency": "USD",
"destination_amount": "0.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "3480.75",
"source_currency": "USD",
"destination_amount": "3480.75",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
}
},
{
"id": "pr_244UfG",
"entity": "ent_2gHL1F",
"type": "regular",
"status": "paid",
"note": null,
"fund_by": "2026-08-29",
"pay_schedule": "ps_baYVU",
"frequency": "biweekly",
"period": {
"starts": "2026-08-01",
"ends": "2026-08-31"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "5464.61",
"source_currency": "USD",
"destination_amount": "5464.61",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
}
},
{...},
{...}
]
}
Payroll
List payrolls
Returns a list of payrolls in your Plane workspace.
GET
/
v1
/
payrolls
List payrolls
curl --request GET \
--url https://api.plane.com/v1/payrolls \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.plane.com/v1/payrolls"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.plane.com/v1/payrolls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plane.com/v1/payrolls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.plane.com/v1/payrolls"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.plane.com/v1/payrolls")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/payrolls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"payrolls": [
{
"id": "pr_26Nch2",
"entity": "ent_2gHL1F",
"type": "regular",
"status": "pending",
"note": null,
"fund_by": "2026-09-30",
"pay_schedule": "ps_baYVU",
"frequency": "biweekly",
"period": {
"starts": "2026-09-14",
"ends": "2026-09-27"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "4500.0",
"source_currency": "USD",
"destination_amount": "4500.0",
"destination_currency": "USD",
"hours": "80.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "344.25",
"source_currency": "USD",
"destination_amount": "344.25",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1019.25",
"source_currency": "USD",
"destination_amount": "1019.25",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "0.0",
"source_currency": "USD",
"destination_amount": "0.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "0.0",
"source_currency": "USD",
"destination_amount": "0.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "0.0",
"source_currency": "USD",
"destination_amount": "0.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "3480.75",
"source_currency": "USD",
"destination_amount": "3480.75",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
}
},
{
"id": "pr_244UfG",
"entity": "ent_2gHL1F",
"type": "regular",
"status": "paid",
"note": null,
"fund_by": "2026-08-29",
"pay_schedule": "ps_baYVU",
"frequency": "biweekly",
"period": {
"starts": "2026-08-01",
"ends": "2026-08-31"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "5464.61",
"source_currency": "USD",
"destination_amount": "5464.61",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
}
},
{...},
{...}
]
}
Parameters
number
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
default is 10.
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 pr_foo,
your subsequent call can include starting_after=pr_foo in order to fetch the next page of the
list.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 pr_bar, your
subsequent call can include ending_before=pr_bar in order to fetch the previous page of the
list.Returns
A dictionary with apayrolls property that contains an array of up to limit payrolls, starting after payroll starting_after.
Each entry in the array is a separate payroll object. If no more payrolls are available, the resulting array will be empty.
Payrolls are ordered by period end, most recent first. Void payrolls are not included.
Each entry carries the payroll’s totals but not its items. To see the payroll items and their
line-by-line breakdown, call Get a payroll.
{
"payrolls": [
{
"id": "pr_26Nch2",
"entity": "ent_2gHL1F",
"type": "regular",
"status": "pending",
"note": null,
"fund_by": "2026-09-30",
"pay_schedule": "ps_baYVU",
"frequency": "biweekly",
"period": {
"starts": "2026-09-14",
"ends": "2026-09-27"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "4500.0",
"source_currency": "USD",
"destination_amount": "4500.0",
"destination_currency": "USD",
"hours": "80.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "344.25",
"source_currency": "USD",
"destination_amount": "344.25",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1019.25",
"source_currency": "USD",
"destination_amount": "1019.25",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "0.0",
"source_currency": "USD",
"destination_amount": "0.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "0.0",
"source_currency": "USD",
"destination_amount": "0.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "0.0",
"source_currency": "USD",
"destination_amount": "0.0",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "3480.75",
"source_currency": "USD",
"destination_amount": "3480.75",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
}
},
{
"id": "pr_244UfG",
"entity": "ent_2gHL1F",
"type": "regular",
"status": "paid",
"note": null,
"fund_by": "2026-08-29",
"pay_schedule": "ps_baYVU",
"frequency": "biweekly",
"period": {
"starts": "2026-08-01",
"ends": "2026-08-31"
},
"totals": {
"earnings": {
"name": null,
"source_amount": "6730.77",
"source_currency": "USD",
"destination_amount": "6730.77",
"destination_currency": "USD",
"hours": "86.67",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"taxes": {
"company": {
"name": null,
"source_amount": "417.31",
"source_currency": "USD",
"destination_amount": "417.31",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"worker": {
"name": null,
"source_amount": "1009.62",
"source_currency": "USD",
"destination_amount": "1009.62",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
},
"benefits": {
"name": null,
"source_amount": "250.0",
"source_currency": "USD",
"destination_amount": "250.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"reimbursements": {
"name": null,
"source_amount": "80.0",
"source_currency": "USD",
"destination_amount": "80.0",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"deductions": {
"name": null,
"source_amount": "336.54",
"source_currency": "USD",
"destination_amount": "336.54",
"destination_currency": "USD",
"hours": "0.0",
"type": null,
"provider_id": null,
"payer": null,
"tax": null
},
"net": {
"name": null,
"source_amount": "5464.61",
"source_currency": "USD",
"destination_amount": "5464.61",
"destination_currency": "USD",
"hours": null,
"type": null,
"provider_id": null,
"payer": null,
"tax": null
}
}
},
{...},
{...}
]
}
Was this page helpful?
⌘I