v1
latestOpenAPI 3.1.02026-07-1274177461.2 KBEmployees
Employments
Get Employee Employment
get/unified/hris/employees/{id}/employments/{subResourceId}
Path parameters
idstring required
subResourceIdstring required
Query parameters
rawboolean nullable
Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
proxyobject nullable
Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
fieldsstring nullable
Example:id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields
The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
expandstring nullable
Example:groups
The comma separated list of fields that will be expanded in the response
Headers
x-account-idstring required
The account identifier
Preferstring
Example:heartbeat
Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)
Response
The Employee Employment with the given identifier was retrieved.
Example response
{
"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"
},
"job_title": "Software Engineer",
"pay_rate": "40.00",
"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."
},
"type": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"label": "Permanent"
},
"contract_type": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"label": "Full-Time"
},
"work_time": {
"duration": "P0Y0M0DT8H0M0S",
"period": {
"value": "month"
}
},
"payroll_code": "PC1",
"employee_id": "1687-3",
"remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z",
"start_date": "2021-01-01T01:01:01.000Z",
"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"
}
},
"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"
}
},
"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"
}
}
],
"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"
}
},
"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"
}
}
]
}
}