Skip to content

List Employees

GET /unified/hris/employees

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

Query Parameters

Refer Specifying query parameters in Truto APIs

employment_statusstring

This represents the employment status. If no clear mapping is available, then the raw value is returned.

Possible values:
activeallexcludedinactivenewHireon_leavependingretiredterminated
34 supported
greytHR
supported
activeinactiveall
Humaans
supported
activeinactiveallnewHire
JumpCloud
supported
activeinactive
Keka
supported
activeinactive
PrimePay HR
supported
activeterminatedon_leaveretiredexcluded
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HROne
supported
HR Partner
supported
IntelliHR
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
groupsobject[]

This represents the groups

References: Groups → id
28 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Rippling
supported
ServiceNow
supported
Workable
supported
Zoho People
supported
idstring
idstring

The unique identifier for groups

namestring

Group's name

typestring

Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.

managerobject

Represents the manager of the employee. Is also an employee.

29 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
Humaans
supported
JumpCloud
supported
Keka
supported
Microsoft 365
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Rippling
supported
ServiceNow
supported
Workable
supported
Zoho People
supported
idstring

The unique identifier for employees

namestring

This represents the name of the employee

employee_numberstring

This represents the employee number

32 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
first_namestring

This represents the first name of the employee

38 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
Zwayam
supported
last_namestring

This represents the last name of the employee

38 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
Zwayam
supported
emailsobject[]

When updated_at is provided, the emails query parameter is ignored.

41 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
Zwayam
supported
emailstring
required·

The email address

is_primaryboolean

Whether the email address is primary

typestring

Set this value only for secondary email.

Possible values:
personal
phonesobject[]

The phones of the user

36 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
PrimePay HR
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
numberstring
required·

The phone number

typestring
required·

The type of phone number

Possible values:
mobilework
extensionstring

The extension of the phone number

created_atstring · date-time

This represents the date when the Employee was created

25 supported
AlexisHR
supported
Breathe
supported
ClayHR
supported
Factorial
supported
Google
supported
Google Workspace
supported
HiBob
supported
HR Cloud
supported
HROne
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Lucca
supported
Microsoft 365
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Square
supported
Zoho People
supported
updated_atstring · date-time

This represents the date when the Employee was updated

24 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
darwinbox
supported
Factorial
supported
greytHR
supported
HeavenHR
supported
HR Cloud
supported
HROne
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
Personio
supported
Rippling
supported
ServiceNow
supported
Square
supported
Zoho People
supported
Zwayam
supported
start_datestring · date-time

This represents the start date

29 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Keka
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Zoho People
supported
termination_datestring · date-time

This represents the termination date

28 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Keka
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Zoho People
supported
namestring

This represents the name of the employee

39 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
companyobject

This represents the company

References: Companies → id
12 supported1 required
Gusto
required
AlexisHR
supported
Charlie
supported
HiBob
supported
HROne
supported
JumpCloud
supported
Microsoft Dynamics 365 Business Central
supported
Oracle Netsuite
supported
Oracle Fusion Cloud HCM
supported
PeopleHR
supported
Rippling
supported
ServiceNow
supported
idstring

The unique identifier for companies

work_locationobject

This represents the work location

References: Locations → id
18 supported
Charlie
supported
ClayHR
supported
Factorial
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
JumpCloud
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
PeopleForce
supported
PeopleHR
supported
Rippling
supported
Square
supported
Zoho People
supported
citystring

The city of the work address

countrystring

The country of the work address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the work address

statestring

The state/province of the work address

street_1string

The first line of work address

street_2string

The second line of work address

genderstring

This represents gender

22 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
Factorial
supported
greytHR
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Keka
supported
Namely
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Zoho People
supported
tagsobject[]

The employee's tags

References: Tags → id
2 supported
HR Partner
supported
Zoho People
supported
idstring

The tag's unique identifier

namestring

The tag's name

productstring

Select the product for which you want to retrieve the employees.

Possible values:
azure_active_directory
1 supported
Microsoft 365
supported
job_titlestring

Job title of the employee

22 supported
AlexisHR
supported
BambooHR
supported
ClayHR
supported
Gusto
supported
HiBob
supported
HROne
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Workable
supported
Zoho People
supported
middle_namestring

This represents the middle name of the employee

12 supported
BambooHR
supported
Breathe
supported
ClayHR
supported
IntelliHR
supported
JumpCloud
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
Rippling
supported
ServiceNow
supported
sort_byobject
1 supported
Namely
supported
created_atstring · date-time

This represents the date when the Employee was created

Possible values:
ascdesc
1 supported
Namely
supported
first_namestring

This represents the first name of the employee

Possible values:
ascdesc
1 supported
Namely
supported
last_namestring

This represents the last name of the employee

Possible values:
ascdesc
1 supported
Namely
supported
updated_atstring · date-time

This represents the date when the Employee was updated

Possible values:
ascdesc
1 supported
Namely
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 Employees

idstring
required·

The unique identifier for employees

42 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
Zwayam
supported
avatarstring

This represents the avatar

11 supported
Charlie
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
Namely
supported
PeopleForce
supported
PeopleHR
supported
ServiceNow
supported
Workable
supported
Zoho People
supported
companyobject

This represents the company

References: Companies → id
12 supported
AlexisHR
supported
Charlie
supported
Gusto
supported
HiBob
supported
HROne
supported
JumpCloud
supported
Microsoft Dynamics 365 Business Central
supported
Oracle Netsuite
supported
Oracle Fusion Cloud HCM
supported
PeopleHR
supported
Rippling
supported
ServiceNow
supported
1 property
idstring

The unique identifier for companies

created_atstring · date-time

This represents the date when the Employee was created

25 supported
AlexisHR
supported
Breathe
supported
ClayHR
supported
Factorial
supported
Google
supported
Google Workspace
supported
HiBob
supported
HR Cloud
supported
HROne
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Lucca
supported
Microsoft 365
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Square
supported
Zoho People
supported
date_of_birthstring

This represents date of birth

28 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Keka
supported
Lucca
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Zoho People
supported
emailsobject[]

The emails of the user

41 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
Zwayam
supported
3 properties
emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

employee_numberstring

This represents the employee number

32 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
employment_statusstring

This represents the employment status. If no clear mapping is available, then the raw value is returned.

Possible values:
activeinactivepending
34 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HROne
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
employmentsobject[]

Represents a role or employment of the employee in the company

References: Employments → id
21 supported
AlexisHR
supported
BambooHR
supported
ClayHR
supported
Gusto
supported
HiBob
supported
HROne
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Lucca
supported
Microsoft 365
supported
MYNDHRX
supported
Namely
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Repute
supported
Rippling
supported
Workable
supported
Zoho People
supported
15 properties
idstring
required·

The unique identifier for employments

created_atstring · date-time

This represents the date when the employments was created

effective_datestring · date-time

Represents the effective date of the employment

employeeobject

Employee associated with this employment

1 property
idstring

The unique identifier for employees

employment_typestring

This represents the employment type

Possible values:
full_timepart_timecontractinternshiptemporarytraineevolunteerper_diem
end_datestring · date-time

Represents the end date of the employment

end_reasonstring

Represents why the employment ended

flsa_statusstring

This represents the flsa status

job_titlestring

Job title of the employee

pay_currencystring

This represents the pay currency

pay_frequencystring

This represents the pay frequency

pay_groupstring

This represents the pay group

pay_periodstring

This represents the pay period

pay_ratenumber

This represents the pay rate

updated_atstring · date-time

This represents the date when the employments was updated

etagstring

The unique identifier for the specific version of the resource.

1 supported
Microsoft Dynamics 365 Business Central
supported
ethnicitystring

This represent ethnicity

6 supported
BambooHR
supported
Breathe
supported
HR Cloud
supported
Namely
supported
Rippling
supported
ServiceNow
supported
first_namestring

This represents the first name of the employee

38 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
Zwayam
supported
genderstring

This represents gender

22 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
Factorial
supported
greytHR
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Keka
supported
Namely
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Zoho People
supported
groupsobject[]

This represents the groups

References: Groups → id
28 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Rippling
supported
ServiceNow
supported
Workable
supported
Zoho People
supported
3 properties
idstring

The unique identifier for groups

namestring

Group's name

typestring

Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.

home_locationobject[]

This represents the home location

References: Locations → id
18 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
Factorial
supported
Hailey HR
supported
HR Cloud
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Namely
supported
PeopleHR
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Zoho People
supported
8 properties
citystring

The city of the home address

countrystring

The country of the home address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the home address

statestring

The state/province of the home address

street_1string

The first line of home address

street_2string

The second line of home address

job_titlestring

Job title of the employee

22 supported
AlexisHR
supported
BambooHR
supported
ClayHR
supported
Gusto
supported
HiBob
supported
HROne
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Workable
supported
Zoho People
supported
last_namestring

This represents the last name of the employee

38 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
Zwayam
supported
managerobject

Represents the manager of the employee. Is also an employee.

29 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
Humaans
supported
JumpCloud
supported
Keka
supported
Microsoft 365
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Rippling
supported
ServiceNow
supported
Workable
supported
Zoho People
supported
2 properties
idstring

The unique identifier for employees

namestring

This represents the name of the employee

marital_statusstring

This represents marital status

9 supported
BambooHR
supported
Breathe
supported
Charlie
supported
Keka
supported
Namely
supported
Personio
supported
Rippling
supported
ServiceNow
supported
Zoho People
supported
middle_namestring

This represents the middle name of the employee

12 supported
BambooHR
supported
Breathe
supported
ClayHR
supported
IntelliHR
supported
JumpCloud
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
Rippling
supported
ServiceNow
supported
namestring

This represents the name of the employee

39 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
pay_groupobject

This represents the pay group

References: PayGroups → id
4 supported
ClayHR
supported
JumpCloud
supported
Keka
supported
Namely
supported
1 property
idstring

The unique identifier for pay groups

phonesobject[]

The phones of the user

36 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HROne
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Keka
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
PrimePay HR
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Square
supported
Workable
supported
Zoho People
supported
3 properties
extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

remote_dataRecord<string, any>

Raw data returned from the remote API call.

ssnstring

This represents the ssn

5 supported
AlexisHR
supported
BambooHR
supported
Factorial
supported
Gusto
supported
Namely
supported
start_datestring · date-time

This represents the start date

29 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Keka
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Zoho People
supported
tagsobject[]

The employee's tags

References: Tags → id
2 supported
HR Partner
supported
Zoho People
supported
2 properties
idstring

The tag's unique identifier

namestring

The tag's name

termination_datestring · date-time

This represents the termination date

28 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Factorial
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
IntelliHR
supported
Keka
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Rippling
supported
ServiceNow
supported
Zoho People
supported
termination_reasonstring

Represents the reason for termination

12 supported
BambooHR
supported
Factorial
supported
greytHR
supported
HiBob
supported
HR Cloud
supported
Humaans
supported
Keka
supported
Namely
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Rippling
supported
termination_typestring

Represents the type of termination. If no clear mapping exists, then raw value is returned.

Possible values:
voluntarydismissedredundancyend_of_contractretirementmutual
10 supported
BambooHR
supported
Factorial
supported
HiBob
supported
Humaans
supported
Keka
supported
Oracle Netsuite
supported
PeopleForce
supported
Personio
supported
Rippling
supported
ServiceNow
supported
updated_atstring · date-time

This represents the date when the Employee was updated

24 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
darwinbox
supported
Factorial
supported
greytHR
supported
HeavenHR
supported
HR Cloud
supported
HROne
supported
Humaans
supported
IntelliHR
supported
Lucca
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
Personio
supported
Rippling
supported
ServiceNow
supported
Square
supported
Zoho People
supported
Zwayam
supported
usernamestring

This represents the username

8 supported
ClayHR
supported
HROne
supported
IntelliHR
supported
JumpCloud
supported
Microsoft 365
supported
Okta
supported
Rippling
supported
ServiceNow
supported
work_locationobject

This represents the work location

References: Locations → id
18 supported
Charlie
supported
ClayHR
supported
Factorial
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
Humaans
supported
JumpCloud
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
MYNDHRX
supported
Namely
supported
PeopleForce
supported
PeopleHR
supported
Rippling
supported
Square
supported
Zoho People
supported
8 properties
citystring

The city of the work address

countrystring

The country of the work address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the work address

statestring

The state/province of the work address

street_1string

The first line of work address

street_2string

The second line of work address

curl -X GET 'https://api.truto.one/unified/hris/employees?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/employees?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/employees"
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',
  'employees',
  { 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",
        "employees",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())