Available OrangeHRM APIs

Tanisha Ray

Updated November 22, 2024 17:18

When you configure an export, import, or other type of flow step using the prebuilt OrangeHRM connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the OrangeHRM API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Employment status	Get employment status	X
	Add employment status		X
	Update employment status		X
	Delete employment status		X
Gender	Request gender data - get	X
Job categories	Get job categories	X
	Add job categories		X
	Update job category		X
Job titles	Get job titles	X
Locations	Get locations	X
	Get a location	X
	Add location		X
	Update location		X
Pay grades	Get pay grades	X
Pay grades	Add pay grades		X
Subunits	Get subunits	X
	Get a subunit	X
	Add subunits		X
	Update subunits		X
	Delete subunits		X
Employee	Get all employees	X
	Get an employee	X
	Get employee attachments	X
	Get employee custom field attachment	X
	Add employee		X
	Update employee		X
Leave balance report	Get leave balance report	X
Leave request	Get leave requests	X
Job record	Get job record	X
Job record	Update job record		X
Custom field value	Get custom field values	X
	Update custom field value		X
	Replace custom field value		X
Leave events	Get leave events	X
Reporting methods	Get reporting methods	X
Employee photos	Get employee photos	X
Reports	Get changed employee data	X
Leave entitlements	Get leave entitlements	X
Timesheet pay hours	Get time sheet pay hours	X
Timesheet	Get timesheet	X
	Get all timesheets	X
	Update time sheet		X
Work week	Get work week	X
Holidays	Get holidays	X
Nationality	Get nationalities list	X
	Add nationality		X
	Update nationality		X
Attendance record	Get attendance records	X
	Add attendance records		X
	Delete attendance records		X
	Update attendance records		X
Jobs	Add job title		X
Jobs	Update job title		X
Employee attachment	Add employee attachment		X
	Update employee attachment		X
	Delete employee attachment		X
Holidays	Add holidays		X
Holidays	Update holidays		X