List Pay Group Employees
curl --request GET \
--url https://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees \
--header 'Authorization: Bearer <token>'import requests
url = "https://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees', 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://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees",
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://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees"
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://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees")
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{
"items": [
{
"id": "<string>",
"external_ref": "<string>",
"work_email": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25"
}
],
"pagination": {
"limit": 123,
"has_next": false,
"has_prev": false,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"total": 0
}
}{
"errors": [
{
"code": "PAY_GROUP_NOT_FOUND",
"message": "Raised when a pay_group is not found."
}
]
}{
"errors": [
{
"code": "ADDRESS_NOT_FOUND",
"message": "<string>",
"field": "<string>",
"params": {}
}
]
}Pay Groups
List Pay Group Employees
The employees whose job.pay_group_id names the pay group on valid_at.
GET
/
organizations
/
{organization_id}
/
payrolls
/
pay-groups
/
{pay_group_id}
/
employees
List Pay Group Employees
curl --request GET \
--url https://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees \
--header 'Authorization: Bearer <token>'import requests
url = "https://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees', 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://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees",
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://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees"
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://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://preview.intermezzo.ai/organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees")
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{
"items": [
{
"id": "<string>",
"external_ref": "<string>",
"work_email": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25"
}
],
"pagination": {
"limit": 123,
"has_next": false,
"has_prev": false,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"total": 0
}
}{
"errors": [
{
"code": "PAY_GROUP_NOT_FOUND",
"message": "Raised when a pay_group is not found."
}
]
}{
"errors": [
{
"code": "ADDRESS_NOT_FOUND",
"message": "<string>",
"field": "<string>",
"params": {}
}
]
}Authorizations
Get token from Auth0 and paste it here
Query Parameters
Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.
Items per page
Required range:
1 <= x <= 100next_cursor of the previous response, for the next page
prev_cursor of the previous response, for the page before it. Not together with cursor.
Fields to order by, - in front for descending (-created_at). Repeat the parameter for more fields. Keep the same sort while following cursors.
Was this page helpful?