v1
latestOpenAPI 3.1.02026-07-1274177461.2 KBEmployees
Get Employee
get/unified/hris/employees/{id}
Path parameters
idstring required
Query parameters
rawboolean nullable
Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
proxyobject nullable
Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
fieldsstring nullable
Example:id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields
The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
expandstring nullable
Example:company,employments,work_location,home_location,groups,skills
The comma separated list of fields that will be expanded in the response
includestring nullable
Example:avatar_url,avatar,custom_fields,job_description,benefits,bank_details
The comma separated list of fields that will be included in the response
Headers
x-account-idstring required
The account identifier
Preferstring
Example:heartbeat
Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)
Response
The employee with the given identifier was retrieved.