MCP
A2AGet Employee
curl --request GET \
--url https://api.stackone.com/unified/hris/employees/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'x-account-id: <x-account-id>'import requests
url = "https://api.stackone.com/unified/hris/employees/{id}"
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-account-id': '<x-account-id>', Authorization: 'Basic <encoded-value>'}
};
fetch('https://api.stackone.com/unified/hris/employees/{id}', 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.stackone.com/unified/hris/employees/{id}",
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: Basic <encoded-value>",
"x-account-id: <x-account-id>"
],
]);
$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.stackone.com/unified/hris/employees/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/unified/hris/employees/{id}")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/hris/employees/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"title": "Mr",
"first_name": "Isaac",
"last_name": "Newton",
"name": "Isaac Newton",
"display_name": "Sir Isaac Newton",
"avatar_url": "https://example.com/avatar.png",
"personal_email": "isaac.newton@example.com",
"personal_phone_number": "+1234567890",
"work_email": "newton@example.com",
"work_phone_number": "+1234567890",
"job_id": "5290",
"job_title": "Physicist",
"job_description": "Testing the laws of motion",
"department_id": "3093",
"department": "Physics",
"groups": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"type": {
"value": "team",
"source_value": "<string>"
}
}
],
"cost_centers": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "R&D",
"distribution_percentage": 100
}
],
"manager_id": "67890",
"remote_manager_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"gender": "male",
"preferred_language": "en_US",
"ethnicity": "white",
"date_of_birth": "1990-01-01T00:00:00.000Z",
"birthday": "2021-01-01T00:00:00Z",
"marital_status": "single",
"avatar": "https://example.com/avatar.png",
"hire_date": "2021-01-01T00:00:00.000Z",
"start_date": "2021-01-01T00:00:00.000Z",
"tenure": 2,
"work_anniversary": "2021-01-01T00:00:00Z",
"employment_type": "full_time",
"employment_contract_type": "full_time",
"employment_status": "active",
"termination_date": "2021-01-01T00:00:00Z",
"company_name": "Example Corp",
"company_id": "1234567890",
"citizenships": [
{
"value": "US",
"source_value": "<string>"
}
],
"home_location": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"employee_id": "1687-3",
"remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"name": "Woolsthorpe Manor",
"phone_number": "+44 1476 860 364",
"street_1": "Water Lane",
"street_2": "Woolsthorpe by Colsterworth",
"city": "Grantham",
"state": "Lincolnshire",
"zip_code": "NG33 5NR",
"country": {
"value": "US",
"source_value": "<string>"
},
"location_type": "work",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"work_location": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"employee_id": "1687-3",
"remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"name": "Woolsthorpe Manor",
"phone_number": "+44 1476 860 364",
"street_1": "Water Lane",
"street_2": "Woolsthorpe by Colsterworth",
"city": "Grantham",
"state": "Lincolnshire",
"zip_code": "NG33 5NR",
"country": {
"value": "US",
"source_value": "<string>"
},
"location_type": "work",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"company": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "StackOne Technologies PLC",
"full_name": "American Express Company",
"display_name": "StackOne",
"created_at": "2023-02-23T00:00:00.000Z",
"updated_at": "2024-02-23T00:00:00.000Z"
},
"employments": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"job_title": "Software Engineer",
"pay_rate": "40.00",
"pay_period": "monthly",
"pay_frequency": "hourly",
"pay_currency": "USD",
"effective_date": "2021-01-01T01:01:01.000Z",
"end_date": "2021-01-01T01:01:01.000Z",
"grade": {
"id": "1687-3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "1687-4",
"description": "Mid-level employee demonstrating proficiency and autonomy."
},
"employment_type": "permanent",
"employment_contract_type": "full_time",
"type": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"label": "Permanent",
"type": "permanent"
},
"contract_type": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"label": "Full-Time",
"contract_type": "full_time"
},
"work_time": {
"duration": "P0Y0M0DT8H0M0S",
"period": "month"
},
"payroll_code": "PC1",
"employee_id": "1687-3",
"remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"fte": "1",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z",
"start_date": "2021-01-01T01:01:01.000Z",
"active": true,
"department": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"type": {
"value": "team",
"source_value": "<string>"
}
},
"cost_center": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"type": {
"value": "team",
"source_value": "<string>"
}
},
"cost_centers": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"distribution_percentage": 85,
"type": {
"value": "team",
"source_value": "<string>"
}
}
],
"division": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"type": {
"value": "team",
"source_value": "<string>"
}
},
"job": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"title": "Software Engineer",
"description": {
"text": "Testing the laws of motion"
},
"owner_id": "5356",
"parent_id": "7577"
},
"manager": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "John Doe",
"email": "john.doe@example.com",
"role": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"label": "Admin",
"role_type": "admin"
}
}
]
}
],
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
],
"benefits": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Health Insurance",
"benefit_type": {
"source_value": "<string>"
},
"provider": "Aetna",
"description": "Health insurance for employees",
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z"
}
],
"employee_number": "125",
"bank_details": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"account_name": "John Doe Primary Account",
"is_primary": true,
"country_code": {
"value": "US",
"source_value": "<string>"
},
"currency_code": {
"value": "USD",
"source_value": "USD"
},
"bank_name": "Chase Bank",
"account_type": {
"value": "checking",
"source_value": "checking"
},
"iban": "GB82WEST12345698765432",
"local_account_number": "1234567890",
"swift_bic": "CHASUS33",
"clearing_codes": [
{
"type": {
"value": "sort_code",
"source_value": "sort_code"
},
"value": "12-34-56"
}
]
}
],
"national_identity_number": {
"value": "123456789",
"type": {
"value": "ssn",
"source_value": "<string>"
},
"country": {
"value": "US",
"source_value": "<string>"
}
},
"national_identity_numbers": [
{
"value": "123456789",
"type": {
"value": "ssn",
"source_value": "<string>"
},
"country": {
"value": "US",
"source_value": "<string>"
}
}
],
"skills": [
{
"id": "16873-IT345",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Information-Technology",
"active": true,
"language": {
"value": "en_GB",
"source_value": "<string>"
},
"maximum_proficiency": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Expert",
"source_value": "<string>"
},
"minimum_proficiency": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Expert",
"source_value": "<string>"
}
}
],
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": {},
"response": {}
}
]
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Get Employee
GET
/
unified
/
hris
/
employees
/
{id}
Get Employee
curl --request GET \
--url https://api.stackone.com/unified/hris/employees/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'x-account-id: <x-account-id>'import requests
url = "https://api.stackone.com/unified/hris/employees/{id}"
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-account-id': '<x-account-id>', Authorization: 'Basic <encoded-value>'}
};
fetch('https://api.stackone.com/unified/hris/employees/{id}', 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.stackone.com/unified/hris/employees/{id}",
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: Basic <encoded-value>",
"x-account-id: <x-account-id>"
],
]);
$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.stackone.com/unified/hris/employees/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/unified/hris/employees/{id}")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/hris/employees/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"title": "Mr",
"first_name": "Isaac",
"last_name": "Newton",
"name": "Isaac Newton",
"display_name": "Sir Isaac Newton",
"avatar_url": "https://example.com/avatar.png",
"personal_email": "isaac.newton@example.com",
"personal_phone_number": "+1234567890",
"work_email": "newton@example.com",
"work_phone_number": "+1234567890",
"job_id": "5290",
"job_title": "Physicist",
"job_description": "Testing the laws of motion",
"department_id": "3093",
"department": "Physics",
"groups": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"type": {
"value": "team",
"source_value": "<string>"
}
}
],
"cost_centers": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "R&D",
"distribution_percentage": 100
}
],
"manager_id": "67890",
"remote_manager_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"gender": "male",
"preferred_language": "en_US",
"ethnicity": "white",
"date_of_birth": "1990-01-01T00:00:00.000Z",
"birthday": "2021-01-01T00:00:00Z",
"marital_status": "single",
"avatar": "https://example.com/avatar.png",
"hire_date": "2021-01-01T00:00:00.000Z",
"start_date": "2021-01-01T00:00:00.000Z",
"tenure": 2,
"work_anniversary": "2021-01-01T00:00:00Z",
"employment_type": "full_time",
"employment_contract_type": "full_time",
"employment_status": "active",
"termination_date": "2021-01-01T00:00:00Z",
"company_name": "Example Corp",
"company_id": "1234567890",
"citizenships": [
{
"value": "US",
"source_value": "<string>"
}
],
"home_location": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"employee_id": "1687-3",
"remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"name": "Woolsthorpe Manor",
"phone_number": "+44 1476 860 364",
"street_1": "Water Lane",
"street_2": "Woolsthorpe by Colsterworth",
"city": "Grantham",
"state": "Lincolnshire",
"zip_code": "NG33 5NR",
"country": {
"value": "US",
"source_value": "<string>"
},
"location_type": "work",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"work_location": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"employee_id": "1687-3",
"remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"name": "Woolsthorpe Manor",
"phone_number": "+44 1476 860 364",
"street_1": "Water Lane",
"street_2": "Woolsthorpe by Colsterworth",
"city": "Grantham",
"state": "Lincolnshire",
"zip_code": "NG33 5NR",
"country": {
"value": "US",
"source_value": "<string>"
},
"location_type": "work",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"company": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "StackOne Technologies PLC",
"full_name": "American Express Company",
"display_name": "StackOne",
"created_at": "2023-02-23T00:00:00.000Z",
"updated_at": "2024-02-23T00:00:00.000Z"
},
"employments": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"job_title": "Software Engineer",
"pay_rate": "40.00",
"pay_period": "monthly",
"pay_frequency": "hourly",
"pay_currency": "USD",
"effective_date": "2021-01-01T01:01:01.000Z",
"end_date": "2021-01-01T01:01:01.000Z",
"grade": {
"id": "1687-3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "1687-4",
"description": "Mid-level employee demonstrating proficiency and autonomy."
},
"employment_type": "permanent",
"employment_contract_type": "full_time",
"type": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"label": "Permanent",
"type": "permanent"
},
"contract_type": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"label": "Full-Time",
"contract_type": "full_time"
},
"work_time": {
"duration": "P0Y0M0DT8H0M0S",
"period": "month"
},
"payroll_code": "PC1",
"employee_id": "1687-3",
"remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"fte": "1",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z",
"start_date": "2021-01-01T01:01:01.000Z",
"active": true,
"department": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"type": {
"value": "team",
"source_value": "<string>"
}
},
"cost_center": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"type": {
"value": "team",
"source_value": "<string>"
}
},
"cost_centers": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"distribution_percentage": 85,
"type": {
"value": "team",
"source_value": "<string>"
}
}
],
"division": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Engineering",
"parent_ids": [
"cxIQNjUyNDM0",
"cxIQNjQzNzI0MQ"
],
"remote_parent_ids": [
"652434",
"6437241"
],
"owner_ids": [
"cxIQNjUyEDM0",
"cxIQNjQzNzA0MQ"
],
"remote_owner_ids": [
"475364",
"4327652"
],
"company_id": "1234567890",
"remote_company_id": "1234567890",
"type": {
"value": "team",
"source_value": "<string>"
}
},
"job": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"title": "Software Engineer",
"description": {
"text": "Testing the laws of motion"
},
"owner_id": "5356",
"parent_id": "7577"
},
"manager": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "John Doe",
"email": "john.doe@example.com",
"role": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"label": "Admin",
"role_type": "admin"
}
}
]
}
],
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
],
"benefits": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Health Insurance",
"benefit_type": {
"source_value": "<string>"
},
"provider": "Aetna",
"description": "Health insurance for employees",
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z"
}
],
"employee_number": "125",
"bank_details": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"account_name": "John Doe Primary Account",
"is_primary": true,
"country_code": {
"value": "US",
"source_value": "<string>"
},
"currency_code": {
"value": "USD",
"source_value": "USD"
},
"bank_name": "Chase Bank",
"account_type": {
"value": "checking",
"source_value": "checking"
},
"iban": "GB82WEST12345698765432",
"local_account_number": "1234567890",
"swift_bic": "CHASUS33",
"clearing_codes": [
{
"type": {
"value": "sort_code",
"source_value": "sort_code"
},
"value": "12-34-56"
}
]
}
],
"national_identity_number": {
"value": "123456789",
"type": {
"value": "ssn",
"source_value": "<string>"
},
"country": {
"value": "US",
"source_value": "<string>"
}
},
"national_identity_numbers": [
{
"value": "123456789",
"type": {
"value": "ssn",
"source_value": "<string>"
},
"country": {
"value": "US",
"source_value": "<string>"
}
}
],
"skills": [
{
"id": "16873-IT345",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Information-Technology",
"active": true,
"language": {
"value": "en_GB",
"source_value": "<string>"
},
"maximum_proficiency": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Expert",
"source_value": "<string>"
},
"minimum_proficiency": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Expert",
"source_value": "<string>"
}
}
],
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": {},
"response": {}
}
]
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
The account identifier
Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)
Example:
"heartbeat"
Path Parameters
Query Parameters
Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
Example:
"id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields"
The comma separated list of fields that will be expanded in the response
Example:
"company,employments,work_location,home_location,groups,skills"
The comma separated list of fields that will be included in the response
Example:
"avatar_url,avatar,custom_fields,job_description,benefits,bank_details"
Was this page helpful?
⌘I