Skip to content
GET /unified/hris/employments

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

companyobject

The company to use, referencing companies.id. Optional: when omitted the account's company is looked up automatically. The request fails if the account can see more than one company and none is given.

1 supported
7shifts
supported
idstring
required
company_idstring

Flat alternative to company.id.

1 supported
7shifts
supported
employeeobject

Employee associated with this employment

References: Employees → id
19 supported5 required14 notes
Officient
required
Omni HR
required

The employee (employees.id, the Omni user id) whose job history to list (one employment per effective-dated Omni job record). Required: Omni HR only exposes this per employee (the user id is part of the path). Exactly one employee: employee_id=, employee[id]=, [eq] or [in] with one id, or a one-element array. Several different ids, any other operator or a non-integer id is refused with a 400 (Omni HR has no multi-employee endpoint).

Remote
required

The employee (employees.id, a Remote employment id). Required: Remote only exposes this data per employment.

Rippling
required

Employee associated with this employment

Sesame
required

Required. The employee (employees.id) whose contracts are listed: Sesame has no company-wide contract list, so a request without it (or with several employees) is refused with a 400. Accepts a plain value, a comma-separated list, repeated keys and [eq]/[in]; any other operator is refused (400) rather than dropped.

7shifts
supported

Filter by employee (employees.id).

Breathe
supported

Employee associated with this employment

Charlie
supported

Employee associated with this employment

Deel
supported

Filter by employee, referencing employees.id (the Deel HRIS profile id).

HR WORKS
supported

Only these employees (employees.id, the HR WORKS person uuid). Sent as persons=&personIdentifierType=uuid. An id HR WORKS does not know returns an empty list. Several values are supported: repeat the parameter, separate them with commas, use the [] form, or the operator forms [eq] / [in]. Any other form (for example [ne] or a nested object) is refused with a 400 instead of being ignored, so a filter Truto cannot express never returns unfiltered data.

Humi by Employment Hero
supported

Return only the employment of this employee (employees.id). Humi has no employment endpoint, so each employee carries exactly one employment (id ":employment"). With this filter the employee is read with GET /v1/employees/{id}?include=salaries, so the record also carries pay_rate and pay_period; an unknown id fails with Humi's error. Without it every employee is listed from GET /v1/employees, which cannot return salaries, so pay fields are empty. Accepted forms: employee[id]=, employee_id=, a repeated parameter or employee[id][]=, employee[id][eq]= and employee[id][in]=; a blank value is ignored. More than one id, or any other form is refused with a 400 instead of being ignored. employee[id][ne] is refused too: Humi reads one employee or the whole company, so excluding an employee would mean reading every employee's data, which this mapping will not do silently.

Justworks
supported

Only these employees (employees.id, Justworks member ids). One id is read directly with GET /v1/members/{member_id}, and a member that does not exist returns Justworks' 404. Justworks has no member-id filter on its list, so two or more ids are read by paging through GET /v1/members and keeping exactly the members you asked for; a page can then come back with fewer records than the limit, or none, and still have a next_cursor. Without the filter, every member is read page by page. When both employee[id] and employee_id are given, both must hold (the ids are intersected), and an intersection with nothing in it returns an empty list without calling Justworks. Accepts one value, a comma-separated list, a repeated employee_id[]=… (or employee_id=… twice) and employee_id[eq]= / employee_id[in]=. A form that cannot be read (another operator, a nested value) is refused with a 400 that names the filter: it is never treated as no filter, which would return everything. Vendors and third-party admins (member types vendor and third_party_admin) are not workers and have no records here, with or without this filter; a member whose type is not visible (no member.detail:read or member.employment:read) is included. One record per employment row of the member (employment_history plus current_employment), which needs the member.employment:read scope: without it Justworks omits them and the list is empty. A row whose status is terminated is not an employment: it ends the row before it. Each row ends where the next row takes effect; the last row ends on the member's termination date. Pay fields (the current row, or the row a termination closes) need member.pay:read.

Paylocity
supported

Only return the employment of these employees (employees.id, the Paylocity Employee ID): one value, a comma-joined list, repeated values (employee_id[] or employee_id=a&employee_id=b), [eq] or [in]; also as employee_id or employee=. Any other form is refused with a 400 before Paylocity is called. Paylocity's batch employee endpoint has no employee filter, so ONE employee is read directly (GET employee; for an unknown employee Paylocity's error is returned as is, and an empty answer gives an empty list), while several employees are found by reading every employee page by page and leaving the others out: pages can then be empty while next_cursor is still set, so keep paging. Without it every employee is read page by page, terminated employees included (activeOnly=false is sent: Paylocity documents no default).

UKG Dimensions
supported

Return only these employees' records (employees.id; at most 100, UKG's own limit for one read). Without it every person is paged through (100 per page) and each page costs one extra call to UKG's Retrieve Persons operation. Accepts one value, several comma-separated, a repeated key (x[]=a&x[]=b) or an eq/in filter; a filter form UKG cannot express is refused with 400 rather than ignored.

Workday
supported

Return the employments (primary job and additional jobs) of one employee (employees.id). Without it, all jobs visible to the account are listed; if Workday returns an unfilled position there, it comes back without employee.

AlexisHR
supported
HR Partner
supported
IntelliHR
supported
ServiceNow
supported
idstring
required·

The unique identifier for employees

employee_idstring
12 supported12 notes
7shifts
supported

Flat alternative to employee.id.

Deel
supported

Flat alternative to employee.id.

HR WORKS
supported

Flat alternative to employee.id (same values and forms).

Humaans
supported

The employee ID you want to get the employments for

Humi by Employment Hero
supported

Flat alternative to employee.id.

Justworks
supported

Flat alternative to employee.id.

Omni HR
supported

Flat alternative to employee.id (same forms).

Paylocity
supported

Flat alternative to employee.id (same forms).

Remote
supported

Flat alternative to employee.id.

Sesame
supported

Flat alternative to employee.id.

UKG Dimensions
supported

Flat alternative to employee.id.

Workday
supported

Flat alternative to employee.id.

start_date
1 supported
AlexisHR
supported
end_datestring · date-time

Represents the end date of the employment

2 supported
AlexisHR
supported
HR Partner
supported
updated_atstring · date-time

This represents the date when the employments was updated

2 supported
AlexisHR
supported
HR Cloud
supported
job_titlestring

Job title of the employee

2 supported
HR Partner
supported
IntelliHR
supported
effective_datestring · date-time

Represents the effective date of the employment

1 supported
HR Partner
supported
include_inactiveboolean

Also return persons who have left the company and were set to gone in HR WORKS (sent as onlyActive=false). By default only active persons are returned (onlyActive=true is sent); a person whose first working day is still in the future counts as active for HR WORKS and is returned by default (Truto reports them as employment_status pending). Deleted persons are never returned. Ignored when a person filter is given: HR WORKS then returns the requested person whatever their status. Accepts true/false in any letter case, also as [eq]; any other value or form (several values, [ne], a nested object) is refused with a 400 instead of being read as false.

1 supported
HR WORKS
supported
sort_byobject
1 supported
IntelliHR
supported
created_atstring · date-time
Possible values:
ascdesc
1 supported
IntelliHR
supported
include_pendingboolean

Also return contracts that are still being set up (PayFit excludes them by default).

1 supported
PayFit
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_key_bystring

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

debugobject

Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.

data
isEmptyResultboolean
isLoopingboolean
nextCursorstring
requestOptionsRecord<string, any>
requestUrlstring
responseHeadersRecord<string, any>
resultCountnumber
next_cursorstring

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

resultobject[]

List of Employments

idstring
required·

The unique identifier for employments

25 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Deel
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
supported
Lucca
supported
Officient
supported
Omni HR
supported
PayFit
supported
Paylocity
supported
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Workday
supported
created_atstring · date-time

This represents the date when the employments was created

10 supported
AlexisHR
supported
Breathe
supported
HiBob
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
effective_datestring · date-time

Represents the effective date of the employment

24 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Deel
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
supported
Lucca
supported
Officient
supported
Omni HR
supported
PayFit
supported
Paylocity
supported
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
employeeobject

Employee associated with this employment

References: Employees → id
25 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Deel
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
supported
Lucca
supported
Officient
supported
Omni HR
supported
PayFit
supported
Paylocity
supported
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Workday
supported
2 properties
idstring

The unique identifier for employees

namestring

The name of the employee

employment_typestring

This represents the employment type

Possible values:
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diem
17 supported
7shifts
supported
Breathe
supported
Charlie
supported
Deel
supported
HR WORKS
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
supported
Omni HR
supported
PayFit
supported
Paylocity
supported
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Workday
supported
end_datestring · date-time

Represents the end date of the employment

21 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Deel
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
supported
Lucca
supported
Officient
supported
PayFit
supported
Paylocity
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
end_reasonstring

Represents why the employment ended

7 supported
AlexisHR
supported
HR WORKS
supported
IntelliHR
supported
Officient
supported
Omni HR
supported
Paylocity
supported
Rippling
supported
flsa_statusstring

This represents the flsa status

2 supported
Justworks
supported
Paylocity
supported
job_titlestring

Job title of the employee

21 supported
Breathe
supported
Charlie
supported
Deel
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
supported
Omni HR
supported
PayFit
supported
Paylocity
supported
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Workday
supported
pay_currencystring

This represents the pay currency

10 supported
Charlie
supported
Deel
supported
HR Cloud
supported
HR Partner
supported
IntelliHR
supported
Justworks
supported
Officient
supported
Remote
supported
Rippling
supported
UKG Dimensions
supported
pay_frequencystring

This represents the pay frequency

9 supported
Charlie
supported
Factorial
supported
HR Cloud
supported
HR Partner
supported
IntelliHR
supported
Justworks
supported
Officient
supported
Paylocity
supported
Rippling
supported
pay_groupstring

This represents the pay group

References: PayGroups → id
1 supported
Paylocity
supported
pay_periodstring

This represents the pay period

7 supported
Charlie
supported
Deel
supported
Humi by Employment Hero
supported
Justworks
supported
Paylocity
supported
Remote
supported
UKG Dimensions
supported
pay_ratenumber

This represents the pay rate

13 supported
Charlie
supported
Deel
supported
Factorial
supported
HR Cloud
supported
HR Partner
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
supported
Officient
supported
Paylocity
supported
Remote
supported
Rippling
supported
UKG Dimensions
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

updated_atstring · date-time

This represents the date when the employments was updated

10 supported
AlexisHR
supported
Breathe
supported
HiBob
supported
HR Cloud
supported
Humaans
supported
Humi by Employment Hero
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
truto unified hris employments \
  -a '<integrated_account_id>' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'hris',
  'employments',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "hris",
        "employments",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())
curl -X GET 'https://api.truto.one/unified/hris/employments?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/hris/employments?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/hris/employments"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())