List Employments
/unified/hris/employments
Partial response — use the "get" endpoint for the full object.
Query Parameters
Refer Specifying query parameters in Truto APIs
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
Flat alternative to company.id.
1 supported
Employee associated with this employment
19 supported5 required14 notes
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).
The employee (employees.id, a Remote employment id). Required: Remote only exposes this data per employment.
Employee associated with this employment
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.
Filter by employee (employees.id).
Employee associated with this employment
Employee associated with this employment
Filter by employee, referencing employees.id (the Deel HRIS profile id).
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.
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.
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.
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).
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.
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.
The unique identifier for employees
12 supported12 notes
Flat alternative to employee.id.
Flat alternative to employee.id.
Flat alternative to employee.id (same values and forms).
The employee ID you want to get the employments for
Flat alternative to employee.id.
Flat alternative to employee.id.
Flat alternative to employee.id (same forms).
Flat alternative to employee.id (same forms).
Flat alternative to employee.id.
Flat alternative to employee.id.
Flat alternative to employee.id.
Flat alternative to employee.id.
1 supported
Represents the end date of the employment
2 supported
This represents the date when the employments was updated
2 supported
Job title of the employee
2 supported
Represents the effective date of the employment
1 supported
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
1 supported
ascdesc
1 supported
Also return contracts that are still being set up (PayFit excludes them by default).
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
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.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
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.
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.
List of Employments
The unique identifier for employments
25 supported
This represents the date when the employments was created
10 supported
Represents the effective date of the employment
24 supported
Employee associated with this employment
25 supported
2 properties
The unique identifier for employees
The name of the employee
This represents the employment type
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diem
17 supported
Represents the end date of the employment
21 supported
Represents why the employment ended
7 supported
This represents the flsa status
2 supported
Job title of the employee
21 supported
This represents the pay currency
10 supported
This represents the pay frequency
9 supported
This represents the pay period
7 supported
This represents the pay rate
13 supported
Raw data returned from the remote API call.
This represents the date when the employments was updated
10 supported
truto unified hris employments \
-a '<integrated_account_id>' \
-o jsonimport 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())