Articles in this section

Available OrangeHRM APIs

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

Assessment

Get assessment

X

Post online trainee answer

X

Get question description

X

Post trainee assessment

X

Post trainee assessment attempt

X

Assignable leave type

Get assignable leave types

X

Attendance configuration

Get attendance configuration

X

Update attendance configuration

X

Attendance record

Get attendance records

X

Add attendance records

X

Delete attendance records

X

Update attendance records

X

Update attendance record

X

Attendance records

Add attendance records

X

Delete attendance records

X

Get attendance records

X

Attendance sheet

Get attendance sheet

X

Update attendance sheet

X

Get attendance sheets

X

Add attendance sheets

X

Bradford factor threshold

Delete Bradford factor threshold

X

Candidate

Post add document template

X

Post add recruited employees

X

Get candidate answer attachment download

X

Get candidate application form

X

Delete candidate comment

X

Update candidate comment

X

Add candidate comments

X

Get candidate data CSV export

X

Add candidate document

X

Get candidate document download

X

Candidate document update

X

Delete candidate document templates

X

Delete candidate documents

X

Delete candidate event comment

X

Update candidate event comment

X

Add candidate event comments

X

Get candidate past vacancy answer attachment download

X

Get candidate past vacancy details

X

Get candidate profile pictures

X

Get candidate question form

X

Get candidate question form answers

X

Get candidate resume download

X

Patch candidate vacancy event

X

Get candidates

X

Delete candidates

X

Post candidates

X

Get document template list

X

Get vacancy event details

X

Patch update document template

X

Get candidate

X

Patch candidate

X

Patch candidate archive

X

Patch candidate shortlist or reject in bulk

X

Patch candidate un-archive

X

Comment

Update comment

X

Add comments

X

Delete comments

X

Get comments

X

Custom field value

Get custom field value

X

Update custom field value

X

Replace custom field value

X

Update custom field value

X

Customers

Add customer

X

Get customer

X

Update customer

X

Delete customers

X

Get customers

X

Directory

Get directory employees

X

Eligible leave type

Get eligible leave types

X

Employee

Get employees

X

Get employee

X

Add employee

X

Update employee

X

Employee attachment

Get employee attachments

X

Get employee custom field attachment

X

Add employee attachment

X

Update employee attachment

X

Delete employee attachment

X

Get employee attachment

X

Employee photos

Get employee photos

X

Employment status

Get employment status

X

Add employment status

X

Update employment status

X

Delete employment status

X

Ethnicity

Get EEO ethnicities

X

External vendor

Get request external vendors data

X

Gender

Get request gender data

X

Goal

Get goal attachment

X

Holidays

Get holidays

X

Add holidays

X

Update holidays

X

Delete holidays

X

In-app marketing

Get in-app marketing data

X

Patch in-app marketing data

X

Job activity

Delete job activity

X

Job and salary events

Update job and salary event

X

Get job and salary event types

X

Add job and salary events

X

Delete job and salary events

X

Get job and salary events

X

Job categories

Get job categories

X

Add job categories

X

Update job categories

X

Delete job categories

X

Job record

Get job record

X

Update job record

X

Delete job record history

X

Get job record history

X

Job titles

Get job titles

X

Add job title

X

Delete job title

X

Get job title

X

Update job title

X

Delete job titles

X

Get job titles

X

Jobs

Add job title

X

Update job title

X

Kudos type

Get kudos types

X

Leave application assign

Post assign leave

X

Leave balance report

Get leave balance report

X

Leave default shift times

Get default shift times

X

Leave entitlements

Get leave entitlements

X

Delete leave entitlement

X

Update leave entitlement

X

Add leave entitlements

X

Leave events

Get leave events

X

Leave period

Get leave periods

X

Leave requests

Get leave request

X

Leave types

Add a new leave type

X

Delete leave types

X

Get leave type list

X

Leave: Work schedule

Get work schedules

X

Like

Add likes on comment

X

Delete likes on comment

X

Get likes on comment

X

Add likes on share

X

Delete likes on share

X

Get likes on share

X

Localization

Get localization languages

X

Get localized language strings

X

Locations

Get locations

X

Get a location

X

Add locations

X

Update locations

X

Delete locations

X

Marital status

Get marital statuses

X

Nationality

Get nationality

X

Add nationality

X

Update nationality

X

Delete nationality

X

Online course

Post course resources view

X

Get employee course resources

X

Get my online course

X

Get my online courses

X

Pay grades

Get pay grades

X

Post pay grades

X

Delete pay grades

X

Power BI reports

Get all reports

X

Projects

Get project

X

Update project

X

Add project activities

X

Delete project activities

X

Get project activities

X

Project activities bulk creation

X

Get project activity

X

Update project activity

X

Add projects

X

Delete projects

X

Get projects

X

Report folder

Patch report folder

X

Report folders

Delete report folders

X

Post report folders

X

Reporting methods

Get reporting methods

X

Delete reporting methods

X

Post reporting methods

X

Reports

Get changed employee data

X

Get report data

X

Settings

Get buzz settings

X

Share

Update buzz share

X

Add buzz shares

X

Delete buzz shares

X

Get buzz shares

X

SSO oauth providers

Get SSO OAuth providers

X

Subunits

Get subunits

X

Get a subunit

X

Add subunits

X

Update subunits

X

Delete subunits

X

System user

Add system user

X

Get system user

X

Update system user

X

Get system users

X

Test connection

Get test connection

X

Timesheet

Get timesheet

X

Get timesheets

X

Update timesheet

X

Timesheet pay hours

Get timesheet pay hours

X

User regions

Get all user regions

X

Get user regions

X

Update user regions

X

User roles

Get assignable user roles

X

Vacancy

Post vacancies

X

Get vacancy

X

Get all vacancy names

X

Delete vacancies

X

Get vacancies

X

Work schedule

Get work schedule

X

Patch work schedule

X

Work schedule country settings

Get work schedule country settings

X

Work schedules

Delete work schedules

X

Get work schedules

X

Post work schedules

X

Work week

Get work week

X

Working weekend

Delete working weekend

X