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

employeeobject

Employee associated with this employment

References: Employees → id
13 supported2 required
Officient
required
Rippling
required
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
ServiceNow
supported
idstring
required·

The unique identifier for employees

namestring

The name of the employee

start_date
1 supported
AlexisHR
supported
end_datestring · date-time

Represents the end date of the employment

12 supported
AlexisHR
supported
Breathe
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
updated_atstring · date-time

This represents the date when the employments was updated

9 supported
AlexisHR
supported
Breathe
supported
HiBob
supported
HR Cloud
supported
Humaans
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
job_titlestring

Job title of the employee

10 supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Rippling
supported
ServiceNow
supported
effective_datestring · date-time

Represents the effective date of the employment

13 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
employee_idstring

The employee ID you want to get the employments for

1 supported
Humaans
supported
sort_byobject
1 supported
IntelliHR
supported
created_atstring · date-time
Possible values:
ascdesc
1 supported
IntelliHR
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.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
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

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

13 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
created_atstring · date-time

This represents the date when the employments was created

9 supported
AlexisHR
supported
Breathe
supported
HiBob
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
effective_datestring · date-time

Represents the effective date of the employment

13 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
employeeobject

Employee associated with this employment

References: Employees → id
13 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
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
5 supported
Breathe
supported
Charlie
supported
IntelliHR
supported
Rippling
supported
ServiceNow
supported
end_datestring · date-time

Represents the end date of the employment

12 supported
AlexisHR
supported
Breathe
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
end_reasonstring

Represents why the employment ended

4 supported
AlexisHR
supported
IntelliHR
supported
Officient
supported
Rippling
supported
flsa_statusstring

This represents the flsa status

job_titlestring

Job title of the employee

10 supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Rippling
supported
ServiceNow
supported
pay_currencystring

This represents the pay currency

6 supported
Charlie
supported
HR Cloud
supported
HR Partner
supported
IntelliHR
supported
Officient
supported
Rippling
supported
pay_frequencystring

This represents the pay frequency

7 supported
Charlie
supported
Factorial
supported
HR Cloud
supported
HR Partner
supported
IntelliHR
supported
Officient
supported
Rippling
supported
pay_groupstring

This represents the pay group

References: PayGroups → id
pay_periodstring

This represents the pay period

1 supported
Charlie
supported
pay_ratenumber

This represents the pay rate

7 supported
Charlie
supported
Factorial
supported
HR Cloud
supported
HR Partner
supported
IntelliHR
supported
Officient
supported
Rippling
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

9 supported
AlexisHR
supported
Breathe
supported
HiBob
supported
HR Cloud
supported
Humaans
supported
Lucca
supported
Officient
supported
Rippling
supported
ServiceNow
supported
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())
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())