Get Employee

GET

unified

hris

employees

{id}

curl --request GET \
  --url https://api.stackone.com/unified/hris/employees/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "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"
    },
    "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.000Z",
    "birthday": "2021-01-01T00:00:00Z",
    "marital_status": "single",
    "avatar": "https://example.com/avatar.png",
    "hire_date": "2021-01-01T00:00.000Z",
    "start_date": "2021-01-01T00: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"
        },
        "employee_id": "1687-3",
        "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "job_title": "Software Engineer",
        "pay_rate": "40.00",
        "pay_period": "monthly",
        "pay_frequency": "hourly",
        "pay_currency": "USD",
        "fte": "1",
        "effective_date": "2021-01-01T01:01:01.000Z",
        "employment_type": "permanent",
        "employment_contract_type": "full_time",
        "work_time": {
          "duration": "P0Y0M0DT8H0M0S",
          "duration_unit": "month"
        },
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z",
        "start_date": "2021-01-01T01:01:01.000Z",
        "end_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"
        },
        "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"
        },
        "manager": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "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": {
          "value": "retirement_savings",
          "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",
    "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",
          "value": "1",
          "source_value": "<string>"
        },
        "minimum_proficiency": {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "name": "Expert",
          "value": "1",
          "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": "<string>",
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxy

object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,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,benefits,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,documents,created_at,updated_at,employee_number,national_identity_number,national_identity_numbers,skills"

expand

string | null

The comma separated list of fields that will be expanded in the response

Example:

"company,employments,work_location,home_location,groups,skills"

include

string | null

The comma separated list of fields that will be included in the response

Example:

"avatar_url,avatar,custom_fields,job_description,benefits"

Response

200

application/json

The employee with the given identifier was retrieved.

data

object

required

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.first_name

string | null

The employee first name

Example:

"Isaac"

data.last_name

string | null

The employee last name

Example:

"Newton"

data.name

string | null

The employee name

Example:

"Isaac Newton"

data.display_name

string | null

The employee display name

Example:

"Sir Isaac Newton"

data.avatar_url

string | null

The employee avatar Url

Example:

"https://example.com/avatar.png"

data.personal_email

string | null

The employee personal email

Example:

"isaac.newton@example.com"

data.personal_phone_number

string | null

The employee personal phone number

Example:

"+1234567890"

data.work_email

string | null

The employee work email

Example:

"newton@example.com"

data.work_phone_number

string | null

The employee work phone number

Example:

"+1234567890"

data.job_id

string | null

deprecated

The employee job id

Example:

"5290"

data.job_title

string | null

deprecated

The employee job title

Example:

"Physicist"

data.job_description

object

deprecated

The employee job description

Example:

"Testing the laws of motion"

data.department_id

string | null

deprecated

The employee department id

Example:

"3093"

data.department

string | null

deprecated

The employee department

Example:

"Physics"

data.groups

object[] | null

The employee groups

data.groups.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.groups.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.groups.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.groups.name

string | null

The name of the group

Example:

"Engineering"

data.groups.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.groups.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.groups.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.groups.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.groups.company_id

string | null

The id of the company that the group belongs to

Example:

"1234567890"

data.groups.remote_company_id

string | null

Provider's id of the company that the group belongs to

Example:

"1234567890"

data.groups.type

object

The type of the group

data.cost_centers

object[] | null

deprecated

The employee cost centers

data.manager_id

string | null

deprecated

The employee manager ID

Example:

"67890"

data.remote_manager_id

string | null

Provider's unique identifier of the manager

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.gender

object

The employee gender

Example:

"male"

data.preferred_language

object

The employee preferred language

Example:

"en_US"

data.ethnicity

object

The employee ethnicity

Example:

"white"

data.date_of_birth

string | null

The employee date_of_birth

Example:

"1990-01-01T00:00.000Z"

data.birthday

string | null

The employee birthday

Example:

"2021-01-01T00:00:00Z"

data.marital_status

object

The employee marital status

Example:

"single"

data.avatar

object

The employee avatar

Example:

"https://example.com/avatar.png"

data.hire_date

string | null

The employee hire date

Example:

"2021-01-01T00:00.000Z"

data.start_date

string | null

deprecated

The employee start date

Example:

"2021-01-01T00:00.000Z"

data.tenure

number | null

The employee tenure

Example:

2

data.work_anniversary

string | null

The employee work anniversary

Example:

"2021-01-01T00:00:00Z"

data.employment_type

object

deprecated

The employee employment type

Example:

"full_time"

data.employment_contract_type

object

deprecated

The employment work schedule type (e.g., full-time, part-time)

Example:

"full_time"

data.employment_status

object

The employee employment status

Example:

"active"

data.termination_date

string | null

The employee termination date

Example:

"2021-01-01T00:00:00Z"

data.company_name

string | null

deprecated

The employee company name

Example:

"Example Corp"

data.company_id

string | null

The employee company id

Example:

"1234567890"

data.citizenships

object[] | null

The citizenships of the Employee

data.home_location

object

The employee home location

data.home_location.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.home_location.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.home_location.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.home_location.employee_id

string | null

The employee ID

Example:

"1687-3"

data.home_location.remote_employee_id

string | null

Provider's unique identifier of the employee

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.home_location.name

string | null

The name of the location

Example:

"Woolsthorpe Manor"

data.home_location.phone_number

string | null

The phone number of the location

Example:

"+44 1476 860 364"

data.home_location.street_1

string | null

The first line of the address

Example:

"Water Lane"

data.home_location.street_2

string | null

The second line of the address

Example:

"Woolsthorpe by Colsterworth"

data.home_location.city

string | null

The city where the location is situated

Example:

"Grantham"

data.home_location.state

string | null

The state where the location is situated

Example:

"Lincolnshire"

data.home_location.zip_code

string | null

The ZIP code/Postal code of the location

Example:

"NG33 5NR"

data.home_location.country

object

The country code

data.home_location.location_type

object

The location type

Example:

"work"

data.home_location.created_at

string | null

The created_at date

Example:

"2021-01-01T01:01:01.000Z"

data.home_location.updated_at

string | null

The updated_at date

Example:

"2021-01-01T01:01:01.000Z"

data.work_location

object

The employee work location

data.work_location.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.work_location.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.work_location.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.work_location.employee_id

string | null

The employee ID

Example:

"1687-3"

data.work_location.remote_employee_id

string | null

Provider's unique identifier of the employee

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.work_location.name

string | null

The name of the location

Example:

"Woolsthorpe Manor"

data.work_location.phone_number

string | null

The phone number of the location

Example:

"+44 1476 860 364"

data.work_location.street_1

string | null

The first line of the address

Example:

"Water Lane"

data.work_location.street_2

string | null

The second line of the address

Example:

"Woolsthorpe by Colsterworth"

data.work_location.city

string | null

The city where the location is situated

Example:

"Grantham"

data.work_location.state

string | null

The state where the location is situated

Example:

"Lincolnshire"

data.work_location.zip_code

string | null

The ZIP code/Postal code of the location

Example:

"NG33 5NR"

data.work_location.country

object

The country code

data.work_location.location_type

object

The location type

Example:

"work"

data.work_location.created_at

string | null

The created_at date

Example:

"2021-01-01T01:01:01.000Z"

data.work_location.updated_at

string | null

The updated_at date

Example:

"2021-01-01T01:01:01.000Z"

data.company

object

The employee company

data.company.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.company.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.company.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.company.name

string | null

The name of the company

Example:

"StackOne Technologies PLC"

data.company.full_name

string | null

The full name of the company

Example:

"American Express Company"

data.company.display_name

string | null

The display name of the company

Example:

"StackOne"

data.company.created_at

string | null

The created_at date

Example:

"2023-02-23T00:00:00.000Z"

data.company.updated_at

string | null

The updated_at date

Example:

"2024-02-23T00:00:00.000Z"

data.employments

object[] | null

The employee employments

data.employments.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.employments.employee_id

string | null

The employee ID associated with this employment

Example:

"1687-3"

data.employments.remote_employee_id

string | null

Provider's unique identifier of the employee associated with this employment

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.employments.job_title

string | null

deprecated

The job title of the employee

Example:

"Software Engineer"

data.employments.pay_rate

string | null

The pay rate for the employee

Example:

"40.00"

data.employments.pay_period

object

The pay period

Example:

"monthly"

data.employments.pay_frequency

object

The pay frequency

Example:

"hourly"

data.employments.pay_currency

string | null

The currency used for pay

Example:

"USD"

data.employments.fte

number | null

the employee’s working percentage relative to a full-time employee

Example:

"1"

data.employments.effective_date

string | null

The effective date of the employment contract

Example:

"2021-01-01T01:01:01.000Z"

data.employments.employment_type

object

deprecated

The type of employment (e.g., contractor, permanent)

Example:

"permanent"

data.employments.employment_contract_type

object

deprecated

The employment work schedule type (e.g., full-time, part-time)

Example:

"full_time"

data.employments.work_time

object

data.employments.created_at

string | null

The created_at date

Example:

"2021-01-01T01:01:01.000Z"

data.employments.updated_at

string | null

The updated_at date

Example:

"2021-01-01T01:01:01.000Z"

data.employments.start_date

string | null

The start_date of employment

Example:

"2021-01-01T01:01:01.000Z"

data.employments.end_date

string | null

The end_date of employment

Example:

"2021-01-01T01:01:01.000Z"

data.employments.active

boolean | null

The employment active status

Example:

true

data.employments.department

object

The employee department

data.employments.department.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.department.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.department.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.employments.department.name

string | null

The name of the group

Example:

"Engineering"

data.employments.department.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.employments.department.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.employments.department.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.employments.department.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.employments.department.company_id

string | null

The id of the company that the group belongs to

Example:

"1234567890"

data.employments.department.remote_company_id

string | null

Provider's id of the company that the group belongs to

Example:

"1234567890"

data.employments.department.type

object

The type of the group

data.employments.cost_center

object

deprecated

The employee cost_center

data.employments.cost_center.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.cost_center.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.cost_center.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.employments.cost_center.name

string | null

The name of the group

Example:

"Engineering"

data.employments.cost_center.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.employments.cost_center.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.employments.cost_center.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.employments.cost_center.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.employments.cost_center.company_id

string | null

The id of the company that the group belongs to

Example:

"1234567890"

data.employments.cost_center.remote_company_id

string | null

Provider's id of the company that the group belongs to

Example:

"1234567890"

data.employments.cost_center.type

object

The type of the group

data.employments.cost_centers

object[] | null

The employee cost_centers

data.employments.cost_centers.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.cost_centers.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.cost_centers.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.employments.cost_centers.name

string | null

The name of the group

Example:

"Engineering"

data.employments.cost_centers.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.employments.cost_centers.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.employments.cost_centers.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.employments.cost_centers.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.employments.cost_centers.company_id

string | null

The id of the company that the group belongs to

Example:

"1234567890"

data.employments.cost_centers.remote_company_id

string | null

Provider's id of the company that the group belongs to

Example:

"1234567890"

data.employments.cost_centers.distribution_percentage

number | null

The distribution percentage for cost_center

Example:

85

data.employments.cost_centers.type

object

The type of the group

data.employments.division

object

The employee division

data.employments.division.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.division.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.employments.division.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.employments.division.name

string | null

The name of the group

Example:

"Engineering"

data.employments.division.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.employments.division.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.employments.division.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.employments.division.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.employments.division.company_id

string | null

The id of the company that the group belongs to

Example:

"1234567890"

data.employments.division.remote_company_id

string | null

Provider's id of the company that the group belongs to

Example:

"1234567890"

data.employments.division.type

object

The type of the group

data.employments.job

object

The job of employee

data.employments.type

object

The type of employment

data.employments.contract_type

object

The employment work schedule type

data.employments.manager

object[] | null

The employee manager

data.custom_fields

object[] | null

The employee custom fields

data.benefits

object[] | null

Current benefits of the employee

data.employee_number

string | null

The assigned employee number

Example:

"125"

data.national_identity_number

object

deprecated

The national identity number

data.national_identity_number.value

string | null

Example:

"123456789"

data.national_identity_number.type

object

data.national_identity_number.country

object

The country code

data.national_identity_numbers

object[] | null

The national identity numbers

data.national_identity_numbers.value

string | null

Example:

"123456789"

data.national_identity_numbers.type

object

data.national_identity_numbers.country

object

The country code

data.skills

object[] | null

The employee skills

data.skills.id

string | null

The ID associated with this skill

Example:

"16873-IT345"

data.skills.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.skills.name

string | null

The name associated with this skill

Example:

"Information-Technology"

data.skills.active

boolean | null

Whether the skill is active and therefore available for use

Example:

true

data.skills.language

object

The language associated with this skill

data.skills.language.value

enum<string> | null

The Locale Code of the language

Available options:

ar_AR,

aa_ER,

af_NA,

af_ZA,

am_ET,

ar_AE,

ar_BH,

ar_DJ,

ar_DZ,

ar_EG,

ar_ER,

ar_IQ,

ar_JO,

ar_KM,

ar_KW,

ar_LB,

ar_LY,

ar_MA,

ar_MR,

ar_OM,

ar_PS,

ar_QA,

ar_SA,

ar_SD,

ar_SY,

ar_TD,

ar_TN,

ar_YE,

ay_BO,

ay_PE,

az_AZ,

az_IR,

be_BY,

bg_BG,

bi_VU,

bn_BD,

bn_IN,

bs_BA,

bs-ME,

byn_ER,

ca_AD,

ca_ES,

ca_FR,

ca_IT,

ch_GU,

cs_CZ,

da_DK,

de_AT,

de_BE,

de_CH,

de_DE,

de_LI,

de_LU,

de_VA,

de_MV,

dv_MV,

dz_BT,

el_CY,

el_GR,

en_AG,

en_AI,

en_AS,

en_AU,

en_BB,

en_BE,

en_BM,

en_BS,

en_BW,

en_BZ,

en_CA,

en_CC,

en_CK,

en_CM,

en_CW,

en_CX,

en_DG,

en_DM,

en_ER,

en_FJ,

en_FK,

en_FM,

en_GB,

en_GD,

en_GG,

en_GH,

en_GI,

en_GM,

en_GS,

en_GU,

en_GY,

en_HK,

en_IE,

en_IM,

en_IN,

en_IO,

en_JE,

en_JM,

en_KE,

en_KI,

en_KN,

en_KY,

en_LC,

en_LR,

en_LS,

en_MF,

en_MG,

en_MH,

en_MO,

en_MP,

en_MS,

en_MT,

en_MU,

en_MW,

en_MY,

en_NA,

en_NF,

en_NG,

en_NL,

en_NR,

en_NU,

en_NZ,

en_PG,

en_PH,

en_PK,

en_PN,

en_PR,

en_PW,

en_RW,

en_SB,

en_SC,

en_SD,

en_SG,

en_SH,

en_SL,

en_SS,

en_SX,

en_SZ,

en_TC,

en_TK,

en_TO,

en_TT,

en_TV,

en_TZ,

en_UG,

en_UM,

en_US,

en_VC,

en_VG,

en_VI,

en_VU,

en_WS,

en_ZA,

en_ZM,

en_ZW,

es_AR,

es_BO,

es_BZ,

es_CL,

es_CO,

es_CR,

es_CU,

es_DO,

es_EA,

es_EC,

es_EH,

es_ES,

es_GQ,

es_GT,

es_HN,

es_IC,

es_LA,

es_MX,

es_NI,

es_PA,

es_PE,

es_PH,

es_PR,

es_PY,

es_SV,

es_US,

es_UY,

es_VE,

et_EE,

fa_AF,

fa_IR,

fan_GA,

ff_CM,

ff_GN,

ff_MR,

ff_SN,

ff_BF,

fi_FI,

fj_FJ,

fo_FO,

fr_BE,

fr_BF,

fr_BI,

fr_BJ,

fr_BL,

fr_CA,

fr_CD,

fr_CF,

fr_CG,

fr_CH,

fr_CI,

fr_CM,

fr_DJ,

fr_DZ,

fr_FR,

fr_GA,

fr_GF,

fr_GG,

fr_GN,

fr_GP,

fr_GQ,

fr_HT,

fr_KM,

fr_JE,

fr_LU,

fr_LB,

fr_MA,

fr_MC,

fr_MF,

fr_MG,

fr_ML,

fr_MQ,

fr_MR,

fr_MU,

fr_NC,

fr_NE,

fr_PF,

fr_PM,

fr_RE,

fr_RW,

fr_SC,

fr_SN,

fr_SY,

fr_TD,

fr_TF,

fr_TG,

fr_TN,

fr_VU,

fr_VA,

fr_WF,

fr_YT,

ga_IE,

gn_PY,

gn_AR,

gu_IN,

gv_IM,

he_IL,

hi_IN,

hr_BA,

hr_HR,

hr_ME,

ht_HT,

hu_HU,

hy_AM,

hy_CY,

id_ID,

is_IS,

it_CH,

it_IT,

it_SM,

it_VA,

ja_JP,

ka_GE,

kg_CD,

kk_KZ,

kl_GL,

km_KH,

ko_KP,

ko_KR,

ku_IQ,

ky_KG,

la_VA,

lb_LU,

ln_AO,

ln_CD,

ln_CF,

ln_CG,

lo_LA,

lt_LT,

lu_CD,

lv_LV,

mg_MG,

mh_MH,

mi_NZ,

mk_MK,

mn_MN,

mr_IN,

ms_BN,

ms_MY,

ms_SG,

mt_MT,

my_MM,

nb_NO,

nb_BV,

nb_ZW,

ne_NP,

nl_AW,

nl_BE,

nl_BQ,

nl_CW,

nl_NL,

nl_SR,

nl_SX,

nl_MF,

nn_NO,

nn_BV,

no_NO,

no_BV,

no_SJ,

nr_ZA,

ny_MW,

pa_IN,

pa_PK,

pl_PL,

ps_AF,

pt_AO,

pt_BR,

pt_CH,

pt_CV,

pt_GQ,

pt_GW,

pt_LU,

pt_MO,

pt_MZ,

pt_PT,

pt_ST,

pt_TL,

qu_BO,

qu_EC,

qu_PE,

rar_CK,

rm_CH,

rup_MK,

ro_MD,

ro_RO,

ru_BY,

ru_KG,

ru_KZ,

ru_MD,

ru_RU,

ru_UA,

ru_AQ,

ru_TJ,

ru_TM,

ru_UZ,

rw_RW,

se_SE,

sg_CF,

si_LK,

sk_SK,

sl_SI,

sm_AS,

sm_WS,

sn_ZW,

so_DJ,

so_ET,

so_KE,

so_SO,

sq_AL,

sq_ME,

sq_XK,

sr_BA,

sr_ME,

sr_RS,

sr_XK,

ss_SZ,

ss_ZA,

sv_AX,

sv_FI,

sv_SE,

sw_KE,

sw_TZ,

sw_UG,

sw_CD,

ta_IN,

ta_MY,

ta_SG,

ta_LK,

te_IN,

tg_TJ,

th_TH,

ti_ER,

ti_ET,

tig_ER,

tk_TM,

tk_AF,

tn_BW,

tn_ZA,

to_TO,

tr_CY,

tr_TR,

ts_ZA,

uk_UA,

ur_IN,

ur_PK,

uz_AF,

uz_UZ,

ve_ZA,

vi_VN,

xh_ZA,

zh_CN,

zh_HK,

zh_MO,

zh_SG,

zh_TW,

zu_ZA

Example:

"en_GB"

data.skills.language.source_value

data.skills.maximum_proficiency

object

The proficiency level of the skill

data.skills.minimum_proficiency

object

The proficiency level of the skill

data.created_at

string | null

The created_at date

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string | null

The updated_at date

Example:

"2021-01-01T01:01:01.000Z"

raw

object[] | null

Was this page helpful?

Raise issue

Creates an employee Updates an 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>'

{
  "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"
    },
    "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.000Z",
    "birthday": "2021-01-01T00:00:00Z",
    "marital_status": "single",
    "avatar": "https://example.com/avatar.png",
    "hire_date": "2021-01-01T00:00.000Z",
    "start_date": "2021-01-01T00: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"
        },
        "employee_id": "1687-3",
        "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "job_title": "Software Engineer",
        "pay_rate": "40.00",
        "pay_period": "monthly",
        "pay_frequency": "hourly",
        "pay_currency": "USD",
        "fte": "1",
        "effective_date": "2021-01-01T01:01:01.000Z",
        "employment_type": "permanent",
        "employment_contract_type": "full_time",
        "work_time": {
          "duration": "P0Y0M0DT8H0M0S",
          "duration_unit": "month"
        },
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z",
        "start_date": "2021-01-01T01:01:01.000Z",
        "end_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"
        },
        "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"
        },
        "manager": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "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": {
          "value": "retirement_savings",
          "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",
    "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",
          "value": "1",
          "source_value": "<string>"
        },
        "minimum_proficiency": {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "name": "Expert",
          "value": "1",
          "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": "<string>",
      "response": {}
    }
  ]
}

HRIS

Common Guides

API Reference

Authorizations

Headers

Path Parameters

Query Parameters

Response