Appearance

List Employments ​

Endpoint ​

http
GET /unified/hris/employments
Integrations supported
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HR Cloud
  • HR Partner
  • Humaans
  • IntelliHR
  • Officient

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

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_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

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
employee
object

Employee associated with this employment

Required in
  • Officient
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • HR Partner
  • IntelliHR
id
string

The unique identifier for employees

name
string

The name of the employee

job_title
string

Job title of the employee

Supported in
  • HR Partner
  • IntelliHR
sort_by
object

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

Supported in
  • IntelliHR
created_at
string · date-time
All possible enum values:
  • asc
  • desc
Supported in
  • IntelliHR
effective_date
string · date-time

Represents the effective date of the employment

Supported in
  • HR Partner
end_date
string · date-time

Represents the end date of the employment

Supported in
  • AlexisHR
  • HR Partner
updated_at
string · date-time

This represents the date when the employments was updated

Supported in
  • AlexisHR
  • HR Cloud
employee_id
string

The employee ID you want to get the employments for

Supported in
  • Humaans
start_date
Supported in
  • AlexisHR

Response Body ​

result
object[]

List of Employments

id
string
REQUIRED · 

The unique identifier for employments

Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HR Cloud
  • HR Partner
  • Humaans
  • IntelliHR
  • Officient
employee
object

Employee associated with this employment

Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HR Cloud
  • HR Partner
  • Humaans
  • IntelliHR
  • Officient
id
string

The unique identifier for employees

name
string

The name of the employee

job_title
string

Job title of the employee

Supported in
  • Breathe
  • Charlie
  • Factorial
  • HR Cloud
  • HR Partner
  • Humaans
  • IntelliHR
pay_rate
number

This represents the pay rate

Supported in
  • Charlie
  • Factorial
  • HR Cloud
  • HR Partner
  • IntelliHR
  • Officient
pay_period
string

This represents the pay period

Supported in
  • Charlie
pay_frequency
string

This represents the pay frequency

Supported in
  • Charlie
  • Factorial
  • HR Cloud
  • HR Partner
  • IntelliHR
  • Officient
pay_currency
string

This represents the pay currency

Supported in
  • Charlie
  • HR Cloud
  • HR Partner
  • IntelliHR
  • Officient
pay_group
string

This represents the pay group

flsa_status
string

This represents the flsa status

effective_date
string · date-time

Represents the effective date of the employment

Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HR Cloud
  • HR Partner
  • Humaans
  • IntelliHR
  • Officient
end_date
string · date-time

Represents the end date of the employment

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • HR Cloud
  • HR Partner
  • Humaans
  • IntelliHR
  • Officient
employment_type
string

This represents the employment type

All possible enum values:
  • full_time
  • part_time
  • contract
  • internship
  • temporary
  • trainee
  • volunteer
  • per_diem
Supported in
  • Breathe
  • Charlie
  • IntelliHR
end_reason
string

Represents why the employment ended

Supported in
  • AlexisHR
  • IntelliHR
  • Officient
created_at
string · date-time

This represents the date when the employments was created

Supported in
  • AlexisHR
  • Breathe
  • Humaans
  • IntelliHR
  • Officient
updated_at
string · date-time

This represents the date when the employments was updated

Supported in
  • AlexisHR
  • Breathe
  • HR Cloud
  • Humaans
  • Officient
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

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.