Skip to content

Get Employees

GET /unified/hris/employees/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

companyobject

This represents the company

References: Companies → id
2 supported2 notes
7shifts
supported

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.

Paychex
supported

Optional. The Paychex company (companies.id), used only to fill company on the employee and look up the work_location details. A company pinned on the connection (company_id in the integrated account context) always wins and this parameter is then ignored. Otherwise, when omitted, the credential's companies are looked up and the single company with API permission is used. The record itself is read by id whatever company is given; when no company resolves, the call still succeeds without that data.

idstring
required·

The unique identifier for companies

company_idstring

Flat alternative to company.id.

2 supported
7shifts
supported
Paychex
supported
include_ssnboolean

true also reads the member's US SSN (GET /v1/members/{member_id}/tax-id): one extra request, and the connection needs the member.tax_id:read scope. The SSN is requested only when the member type is visible (member.detail:read or member.employment:read) and is one Justworks can hold an SSN for: not for international_contractor, employee_eor, international_employee, third_party_admin and vendor. When Justworks answers that it has no SSN for the member (404, no SSN on file; 400, SSN not supported for the member type) or answers without one, the member is returned without ssn. Any other error of that request fails the whole get: 401, 403 (the connection lacks member.tax_id:read), 429, 5xx. The SSN appears only in ssn, never in remote_data. Not available on list.

1 supported
Justworks
supported
productstring

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

Possible values:
azure_active_directory
1 supported
Microsoft 365
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_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

idstring
required·

The unique identifier for employees

55 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
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
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
avatarstring

This represents the avatar

17 supported
7shifts
supported
Charlie
supported
HiBob
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Keka
supported
Namely
supported
Officient
supported
Omni HR
supported
Paychex
supported
PeopleForce
supported
PeopleHR
supported
ServiceNow
supported
Sesame
supported
Workable
supported
Zoho People
supported
companyobject

This represents the company

References: Companies → id
22 supported
7shifts
supported
AlexisHR
supported
Charlie
supported
Deel
supported
Gusto
supported
HiBob
supported
Humaans
supported
JumpCloud
supported
Justworks
supported
Kenjo
supported
Microsoft Dynamics 365 Business Central
supported
Oracle Netsuite
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
Paylocity
supported
PeopleHR
supported
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Workday
supported
idstring

The unique identifier for companies

created_atstring · date-time

This represents the date when the Employee was created

31 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
ClayHR
supported
Deel
supported
Factorial
supported
Google
supported
Google Workspace
supported
HiBob
supported
HR Cloud
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Lucca
supported
Microsoft 365
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Oracle Fusion Cloud HCM
supported
PeopleForce
supported
Personio
supported
PrimePay HR
supported
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
Zoho People
supported
date_of_birthstring

This represents date of birth

46 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
supported
Factorial
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Officient
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
RazorpayX Payroll
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
emailsobject[]

The emails of the user

55 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
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
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
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

44 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
ClayHR
supported
darwinbox
supported
Deel
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
Personio
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
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
47 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
Deel
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
employmentsobject[]

Represents a role or employment of the employee in the company

References: Employments → id
39 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
ClayHR
supported
Deel
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
HR WORKS
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Namely
supported
Officient
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
RazorpayX Payroll
supported
Repute
supported
Rippling
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
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

10 supported
BambooHR
supported
Breathe
supported
Deel
supported
HR Cloud
supported
Namely
supported
Paychex
supported
Paylocity
supported
Rippling
supported
ServiceNow
supported
Workday
supported
first_namestring

This represents the first name of the employee

52 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
supported
Factorial
supported
Google
supported
Google Workspace
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
genderstring

This represents gender

35 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
Deel
supported
Factorial
supported
greytHR
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
Keka
supported
Kenjo
supported
Namely
supported
Officient
supported
Omni HR
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
groupsobject[]

This represents the groups

References: Groups → id
45 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
RazorpayX Payroll
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
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
37 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
Deel
supported
Factorial
supported
Gusto
supported
Hailey HR
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Keka
supported
Kenjo
supported
Namely
supported
Officient
supported
Omni HR
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleHR
supported
PrimePay HR
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
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

41 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
ClayHR
supported
Deel
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
HR WORKS
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Officient
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
RazorpayX Payroll
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
last_namestring

This represents the last name of the employee

52 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
supported
Factorial
supported
Google
supported
Google Workspace
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
managerobject

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

46 supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
supported
Factorial
supported
Google
supported
Google Workspace
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humi by Employment Hero
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Microsoft 365
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
idstring

The unique identifier for employees

namestring

This represents the name of the employee

marital_statusstring

This represents marital status

17 supported
BambooHR
supported
Breathe
supported
Charlie
supported
Keka
supported
Kenjo
supported
Namely
supported
Officient
supported
Omni HR
supported
Paylocity
supported
Personio
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
middle_namestring

This represents the middle name of the employee

19 supported
BambooHR
supported
Breathe
supported
ClayHR
supported
Deel
supported
Humaans
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
Rippling
supported
ServiceNow
supported
UKG Dimensions
supported
Workday
supported
namestring

This represents the name of the employee

54 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
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
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
pay_groupobject

This represents the pay group

References: PayGroups → id
6 supported
ClayHR
supported
JumpCloud
supported
Keka
supported
Namely
supported
Paylocity
supported
Workday
supported
idstring

The unique identifier for pay groups

phonesobject[]

The phones of the user

53 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
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
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Lucca
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
UKG Dimensions
supported
Workable
supported
Workday
supported
Zoho People
supported
Zwayam
supported
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

14 supported
AlexisHR
supported
BambooHR
supported
Deel
supported
Factorial
supported
Gusto
supported
HR Partner
supported
HR WORKS
supported
Justworks
supported
Namely
supported
Officient
supported
Paychex
supported
PayFit
supported
Paylocity
supported
Sesame
supported
start_datestring · date-time

This represents the start date

47 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
supported
Kallidus
supported
Keka
supported
Kenjo
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Oracle Netsuite
supported
Officient
supported
Okta
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
RazorpayX Payroll
supported
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Workable
supported
Workday
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

termination_datestring · date-time

This represents the termination date

42 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
Charlie
supported
ClayHR
supported
darwinbox
supported
Deel
supported
Factorial
supported
greytHR
supported
Gusto
supported
Hailey HR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
supported
Kallidus
supported
Keka
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Officient
supported
Omni HR
supported
Oracle Fusion Cloud HCM
supported
Paychex
supported
PayFit
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
PrimePay HR
supported
Remote
supported
Repute
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
UKG Dimensions
supported
Zoho People
supported
termination_reasonstring

Represents the reason for termination

18 supported
BambooHR
supported
Factorial
supported
greytHR
supported
HiBob
supported
HR Cloud
supported
HR WORKS
supported
Humaans
supported
Keka
supported
Namely
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Repute
supported
Rippling
supported
Zoho People
supported
termination_typestring

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

Possible values:
voluntarydismissedredundancyend_of_contractretirementmutual
14 supported
BambooHR
supported
Deel
supported
Factorial
supported
HiBob
supported
HR WORKS
supported
Humaans
supported
Keka
supported
Oracle Netsuite
supported
Omni HR
supported
Paylocity
supported
PeopleForce
supported
Personio
supported
Rippling
supported
ServiceNow
supported
updated_atstring · date-time

This represents the date when the Employee was updated

28 supported
7shifts
supported
AlexisHR
supported
BambooHR
supported
Breathe
supported
darwinbox
supported
Deel
supported
Factorial
supported
greytHR
supported
HeavenHR
supported
HR Cloud
supported
Humaans
supported
Humi by Employment Hero
supported
IntelliHR
supported
Justworks
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
Remote
supported
Rippling
supported
ServiceNow
supported
Sesame
supported
Square
supported
Zoho People
supported
usernamestring

This represents the username

13 supported
7shifts
supported
ClayHR
supported
HR Partner
supported
HR WORKS
supported
IntelliHR
supported
JumpCloud
supported
Kallidus
supported
Microsoft 365
supported
Okta
supported
Remote
supported
Rippling
supported
ServiceNow
supported
UKG Dimensions
supported
work_locationobject

This represents the work location

References: Locations → id
31 supported
7shifts
supported
Charlie
supported
ClayHR
supported
Deel
supported
Factorial
supported
Gusto
supported
Hailey HR
supported
HeavenHR
supported
HiBob
supported
HR Cloud
supported
HR Partner
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
JumpCloud
supported
Justworks
supported
Kallidus
supported
Microsoft 365
supported
Microsoft Dynamics 365 Business Central
supported
Namely
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Rippling
supported
Sesame
supported
Square
supported
Workday
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

truto unified hris employees '<resource_id>' \
  -m get \
  -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.get(
  'hris',
  'employees',
  '<resource_id>',
  { 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():
    result = await truto_api.unified_api.get(
        "hris",
        "employees",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X GET 'https://api.truto.one/unified/hris/employees/{id}?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/{id}?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/{id}"
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())