Appearance

Get Employments ​

Endpoint ​

http
GET /unified/hris/employments/{id}
Integrations supported
  • AlexisHR
  • Charlie
  • HR Cloud
  • Humaans
  • IntelliHR

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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 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.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
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

Response Body ​

id
string
REQUIRED · 

The unique identifier for employments

Supported in
  • AlexisHR
  • Charlie
  • HR Cloud
  • Humaans
  • IntelliHR
employee
object

Employee associated with this employment

Supported in
  • AlexisHR
  • Charlie
  • HR Cloud
  • Humaans
  • 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
  • Charlie
  • HR Cloud
  • Humaans
  • IntelliHR
pay_rate
number

This represents the pay rate

Supported in
  • Charlie
  • HR Cloud
  • IntelliHR
pay_period
string

This represents the pay period

Supported in
  • Charlie
pay_frequency
string

This represents the pay frequency

Supported in
  • Charlie
  • HR Cloud
  • IntelliHR
pay_currency
string

This represents the pay currency

Supported in
  • Charlie
  • HR Cloud
  • IntelliHR
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
  • Charlie
  • HR Cloud
  • Humaans
  • IntelliHR
end_date
string · date-time

Represents the end date of the employment

Supported in
  • AlexisHR
  • HR Cloud
  • Humaans
  • IntelliHR
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
  • Charlie
  • IntelliHR
end_reason
string

Represents why the employment ended

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

This represents the date when the employments was created

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

This represents the date when the employments was updated

Supported in
  • AlexisHR
  • HR Cloud
  • Humaans
remote_data
object

Raw data returned from the remote API call.