Appearance

Get Employments ​

Endpoint ​

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

Path parameters ​

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Response Body ​

id
string
REQUIRED · The unique identifier for employments
Supported in
  • HR Cloud
  • Humaans
employee
object
Employee associated with this employment
Supported in
  • HR Cloud
  • Humaans
id
string
The unique identifier for employees
job_title
string
Job title of the employee
Supported in
  • HR Cloud
  • Humaans
pay_rate
number
This represents the pay rate
Supported in
  • HR Cloud
pay_period
string
This represents the pay period
pay_frequency
string
This represents the pay frequency
Supported in
  • HR Cloud
pay_currency
string
This represents the pay currency
Supported in
  • HR Cloud
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
  • HR Cloud
  • Humaans
end_date
string · date-time
Represents the end date of the employment
Supported in
  • HR Cloud
  • Humaans
employment_type
string
This represents the employment type
All possible enum values:
  • full_time
  • part_time
  • contract
  • internship
  • temporary
  • trainee
  • volunteer
  • per_diem
end_reason
string
Represents why the employment ended
created_at
string
This represents the date when the employments was created
Supported in
  • Humaans
updated_at
string
This represents the date when the employments was updated
Supported in
  • HR Cloud
  • Humaans
remote_data
object
Raw data returned from the remote API call.