Get Employees
curl --request GET \
--url https://api.twine.se/v1/org/employees \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.twine.se/v1/org/employees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.twine.se/v1/org/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://api.twine.se/v1/org/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://api.twine.se/v1/org/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://api.twine.se/v1/org/employees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.twine.se/v1/org/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{
"data": [
{
"id": "018eae56-8f9d-7ca0-bea3-17f3db6cf75b",
"org_id": "018eae56-8f9d-7ca0-bea3-17f3db6cf75b",
"employee_mappings": [
{
"employee_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"inserted_at": "2023-11-07T05:31:56Z",
"status": "active",
"status_updated_at": "2023-11-07T05:31:56Z",
"system_integration_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"inserted_at": "2021-06-01T12:00:00Z",
"organizational_unit_mappings": [
{
"employee_id": "<string>",
"external_employee_id": "<string>",
"external_organizational_unit_id": "<string>",
"id": "<string>",
"organizational_unit_id": "<string>"
}
],
"properties": {
"lead_in_unit_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_clearing_nr": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"cost_center_2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_line_1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"org_unit_type": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_payout_frequency": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_bic": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_state": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"child_personal_id_number": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"source_organizational_unit_external_ids": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_country_iso": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"position_code": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"office_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_currency": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"org_unit_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_type_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_category_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_swift": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_postal_code": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"ssn": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_period": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_line_1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_type_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_termination_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"company_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_rate": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"full_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_amount": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_email1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_country": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"phone3": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"personal_id_number": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_line_3": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_leave_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"email3": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_relationship": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_line_2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_country": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_type_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"office_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"legal_entity_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_hire_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"salary_currency": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_tenure_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_start_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"tax_table_nr": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_iban": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_email": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_city": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"subordinate_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_city": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"department_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_termination_reason": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_last_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"birthdate": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"company_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"custom_properties": {},
"gender": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_amount": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_phone": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"nationality": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"cost_center_1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"location_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_probation_end_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"bank_country_iso": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_full_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"honorific_prefix": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_email2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_payout_day": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_payout_schedule": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"department_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"phone4": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"source_external_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"position_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"child_first_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_weekly_hours": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"legal_entity_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_line_2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"phone1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_first_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"child_birthdate": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"employee_no": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_first_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"tax_table_column": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_period": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"team_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"phone2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"is_manager": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"cost_center_1_weight": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"email1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_last_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"source_external_manager_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_postal_code": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"email2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"middle_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"last_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_type_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"child_last_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"location_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"cost_center_2_weight": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_type_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"honorific_suffix": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_country_iso": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_type": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"position_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_account_nr": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"team_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_state": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"org_unit_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"division_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_terminated": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"username": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_category_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_full_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_payout_frequency": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"display_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"first_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"active_status": [
{
"valid_from": "2021-06-01",
"value": "active"
}
],
"division_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_line_3": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_fte_weekly_hours": [
{
"valid_from": "2021-06-01",
"value": null
}
]
},
"source_system": "personio",
"updated_at": "2021-06-01T12:00:00Z"
}
],
"pagination": {
"end_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true,
"start_cursor": "<string>"
}
}{
"code": 400,
"errors": [],
"message": "Bad Request"
}{
"code": 403,
"errors": [],
"message": "Forbidden"
}{
"code": 500,
"errors": [],
"message": "Internal Server Error"
}Employees
Get Employees
Get a list of employees for a given organization. Supports cursor-based pagination, filtering, and ordering.
GET
/
v1
/
org
/
employees
Get Employees
curl --request GET \
--url https://api.twine.se/v1/org/employees \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.twine.se/v1/org/employees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.twine.se/v1/org/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://api.twine.se/v1/org/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://api.twine.se/v1/org/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://api.twine.se/v1/org/employees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.twine.se/v1/org/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{
"data": [
{
"id": "018eae56-8f9d-7ca0-bea3-17f3db6cf75b",
"org_id": "018eae56-8f9d-7ca0-bea3-17f3db6cf75b",
"employee_mappings": [
{
"employee_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"inserted_at": "2023-11-07T05:31:56Z",
"status": "active",
"status_updated_at": "2023-11-07T05:31:56Z",
"system_integration_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"inserted_at": "2021-06-01T12:00:00Z",
"organizational_unit_mappings": [
{
"employee_id": "<string>",
"external_employee_id": "<string>",
"external_organizational_unit_id": "<string>",
"id": "<string>",
"organizational_unit_id": "<string>"
}
],
"properties": {
"lead_in_unit_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_clearing_nr": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"cost_center_2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_line_1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"org_unit_type": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_payout_frequency": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_bic": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_state": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"child_personal_id_number": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"source_organizational_unit_external_ids": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_country_iso": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"position_code": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"office_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_currency": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"org_unit_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_type_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_category_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_swift": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_postal_code": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"ssn": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_period": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_line_1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_type_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_termination_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"company_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_rate": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"full_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_amount": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_email1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_country": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"phone3": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"personal_id_number": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_line_3": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_leave_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"email3": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_relationship": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_line_2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_country": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_type_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"office_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"legal_entity_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_hire_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"salary_currency": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_tenure_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_start_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"tax_table_nr": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_iban": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_email": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_city": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"subordinate_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_2_city": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"department_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_termination_reason": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_last_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"birthdate": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"company_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"custom_properties": {},
"gender": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_amount": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_phone": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"nationality": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"cost_center_1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"location_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_probation_end_date": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"bank_country_iso": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_full_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"honorific_prefix": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_email2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_payout_day": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_payout_schedule": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"department_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"phone4": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"source_external_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"position_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"child_first_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_weekly_hours": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"legal_entity_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_line_2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"phone1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_first_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"child_birthdate": [
{
"valid_from": "2021-06-01",
"value": "2021-06-01T12:00:00Z"
}
],
"employee_no": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_first_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"tax_table_column": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"salary_period": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"team_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"phone2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"is_manager": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"cost_center_1_weight": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"email1": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"manager_last_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"source_external_manager_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_postal_code": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"email2": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"middle_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"last_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_type_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"child_last_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"location_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"cost_center_2_weight": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_type_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"honorific_suffix": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_country_iso": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_type": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"position_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"bank_account_nr": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"team_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_state": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"org_unit_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"division_id": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_terminated": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"username": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_category_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"next_of_kin_full_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"variable_pay_payout_frequency": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"display_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"first_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"active_status": [
{
"valid_from": "2021-06-01",
"value": "active"
}
],
"division_name": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"address_1_line_3": [
{
"valid_from": "2021-06-01",
"value": null
}
],
"employment_fte_weekly_hours": [
{
"valid_from": "2021-06-01",
"value": null
}
]
},
"source_system": "personio",
"updated_at": "2021-06-01T12:00:00Z"
}
],
"pagination": {
"end_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true,
"start_cursor": "<string>"
}
}{
"code": 400,
"errors": [],
"message": "Bad Request"
}{
"code": 403,
"errors": [],
"message": "Forbidden"
}{
"code": 500,
"errors": [],
"message": "Internal Server Error"
}Authorizations
Bearer token for authentication
Query Parameters
Bracket syntax, one key per field: pagination[first]=50, then pagination[first]=50&pagination[after]=<end_cursor> for the next page.
Cursor pagination
Show child attributes
Show child attributes
Filter parameters for Employee
Bracket syntax, two keys per filtered field: filters[<field>][op]=<op>&filters[<field>][value]=<value>, e.g. filters[updated_at][op]=gt&filters[updated_at][value]=2026-01-01T00:00:00Z. Combine fields by adding more keys; every filter must match.
With op=in, separate the values with commas: filters[id][op]=in&filters[id][value]=<uuid>,<uuid>. filters[id][value][]=<uuid>&filters[id][value][]=<uuid> is accepted too.
Parameters for Employee filtering
Show child attributes
Show child attributes
Bracket syntax: order[field]=<field>&order[direction]=desc.
Parameters for Employee ordering
Show child attributes
Show child attributes
Relations to include for each Employee. employee_mappings adds the employee's id in every integration that knows it, organizational_unit_mappings the organizational units the employee belongs to, with their external ids.
Separate values with commas: relations=employee_mappings,organizational_unit_mappings. These are accepted too:
relations[]=employee_mappings&relations[]=organizational_unit_mappingsrelations=employee_mappings&relations=organizational_unit_mappingsrelations[0]=employee_mappings&relations[1]=organizational_unit_mappings
Spaces around the commas are ignored. Values are case-sensitive, and an unknown value returns 400.
Parameters for Employee relations selection.
Available options:
employee_mappings, organizational_unit_mappings Select fields for Employee
Separate values with commas: select=properties.first_name,properties.email1. These are accepted too:
select[]=properties.first_name&select[]=properties.email1select=properties.first_name&select=properties.email1select[0]=properties.first_name&select[1]=properties.email1
Spaces around the commas are ignored. Values are case-sensitive, and an unknown value returns 400.
Parameters for Employee field selection. The actual type of properties.custom_properties will vary depending on your usage.
Note: id and org_id are always returned.
Available options:
id, org_id, updated_at, inserted_at, properties, properties.source_external_id, properties.source_external_manager_id, properties.source_organizational_unit_external_ids, properties.active_status, properties.username, properties.birthdate, properties.personal_id_number, properties.ssn, properties.nationality, properties.first_name, properties.last_name, properties.middle_name, properties.honorific_prefix, properties.honorific_suffix, properties.full_name, properties.display_name, properties.gender, properties.child_first_name, properties.child_last_name, properties.child_birthdate, properties.child_personal_id_number, properties.email1, properties.email2, properties.email3, properties.phone1, properties.phone2, properties.phone3, properties.phone4, properties.address_1_line_1, properties.address_1_line_2, properties.address_1_line_3, properties.address_1_postal_code, properties.address_1_city, properties.address_1_state, properties.address_1_country, properties.address_1_country_iso, properties.address_2_line_1, properties.address_2_line_2, properties.address_2_line_3, properties.address_2_postal_code, properties.address_2_city, properties.address_2_state, properties.address_2_country, properties.address_2_country_iso, properties.tax_table_nr, properties.tax_table_column, properties.bank_name, properties.bank_account_nr, properties.bank_clearing_nr, properties.bank_country_iso, properties.bank_swift, properties.bank_iban, properties.bank_bic, properties.employee_no, properties.department_id, properties.department_name, properties.division_id, properties.division_name, properties.team_id, properties.team_name, properties.office_id, properties.office_name, properties.location_id, properties.location_name, properties.company_id, properties.company_name, properties.legal_entity_id, properties.next_of_kin_full_name, properties.next_of_kin_first_name, properties.next_of_kin_last_name, properties.next_of_kin_email, properties.next_of_kin_phone, properties.next_of_kin_relationship, properties.legal_entity_name, properties.lead_in_unit_id, properties.org_unit_id, properties.org_unit_name, properties.org_unit_type, properties.cost_center_1, properties.cost_center_2, properties.cost_center_1_weight, properties.cost_center_2_weight, properties.manager_id, properties.manager_first_name, properties.manager_last_name, properties.manager_full_name, properties.manager_email1, properties.manager_email2, properties.subordinate_id, properties.is_manager, properties.salary_amount, properties.salary_currency, properties.salary_type_name, properties.salary_type_id, properties.salary_payout_day, properties.salary_period, properties.salary_payout_frequency, properties.salary_payout_schedule, properties.variable_pay_amount, properties.variable_pay_currency, properties.variable_pay_type, properties.variable_pay_type_name, properties.variable_pay_period, properties.variable_pay_payout_frequency, properties.employment_start_date, properties.employment_hire_date, properties.employment_leave_date, properties.position_id, properties.position_code, properties.position_name, properties.employment_probation_end_date, properties.employment_type_id, properties.employment_type_name, properties.employment_tenure_name, properties.employment_category_id, properties.employment_category_name, properties.employment_rate, properties.employment_weekly_hours, properties.employment_fte_weekly_hours, properties.employment_terminated, properties.employment_termination_reason, properties.employment_termination_date, properties.custom_properties, properties.has_remote_entity Select mapped fields by SystemIntegration ID. Specify "all" to aggregate all mappings defined in your organization. Overrides select. Note: id and org_id are always returned.
Id of an organization-wide condition (see GET /v1/org/conditions) whose domain is
employee. Only records the condition passes are returned; filters still apply
first. Record properties are encrypted at rest, so the condition runs in the
application after the page is read and decrypted: a page may be shorter than first,
even empty, while has_next_page is still true. Keep paging until has_next_page
is false. pagination[last] /
pagination[before] are not supported together with a condition. An unknown id or a
condition of another domain is a 400. No permission on conditions is needed to filter
by one; list on this resource is enough.