Jump to Content

API Reference

Documentation

Getting Started
Authorization
API Usage
Try It Yourself!

Admin

Education
Email Configuration
- Get Email Configurationget
- Update Email Configurationput
Email Subscriber
Email Subscription
- List All Email Subscriptionsget
- Update an Email Subscriptionput
Employment Status
I18N
I18N Language Import
- Import I18N languagepost
Job Category
Job Specification
- Get Job Specificationget
Job Title
Languages
License
Localization
- Get Localization Settingsget
- Update Localization Settingsput
Locations
Memberships
Modules
- List All Modulesget
- Update a Moduleput
Nationality
Organization
- Get Organization Detailsget
- Update Organization Detailsput
Pay Grade
Pay Grade Currency
Skills
Subunits
Users
Work Shift
Theme
LDAP Configuration
LDAP User Sync
- Get User Sync Detailsget
- Sync LDAP Userpost

Attendance

Configuration
- Get Attendance Configurationget
- Update Attendance Configurationput
Overlap
Attendance Record
Current Date Time
- Get the Current Date & Timeget
Employee Attendance
Employee Attendance Summary
- Summarize Employee Attendanceget
Timezones
- List Timezonesget

Buzz

Comments
Feed
- List the Buzz Feedget
Comment Likes
Share Likes
Post
Shares
Validation
- Validate Video Linkget
Employee Anniversary
- List Upcoming Employee Anniversariesget

Claim

Attachments
Events
Expenses
Expense Types
Requests
My Requests

Core

About Organization
- Get Basic Organization Detailsget
Unique Validation
- Validate Uniquenessget

Dashboard

Widgets

Directory

Employees
- Get an Employee Directory Listingget
- Get the Employee Directoryget

Leave

Employee Bulk Leave
- Bulk Approve/Cancel/Reject Leavesput
Leave Type
Employee Bulk Leave Request
- Bulk Approve/Cancel/Reject Leave Requestsput
Employee Leave
- List All Employee Leavesget
Leave Balance
- Get an Employee's Leave Balanceget
- Get Leave Balance for a Leave Typeget
Entitlements
Employee Leave Request
Holiday
Leaves
- List All Leaves in a Leave Requestget
- Update a Leaveput
Leave Comment
- List All Comments for a Leaveget
- Comment on a Leavepost
Overlap Leave
- Get Overlapping Leavesget
Leave Period
Leave Report
- Get Leave Reportget
- Get Leave Report Dataget
Leave Request Comment
- List Comments for a Leave Requestget
- Comment on a Leave Requestpost
My Leave Request
Validation
- Validate Leave Entitlementget
Work Week
- Get Work Weekget
- Update Work Weekput

Maintenance

Purge Candidate
- Purge Candidatedel
- List Purgeable Candidates for a Vacancyget
Purge Employee
- Purge Employeedel

Mobile

Menu Items
- List Mobile Menu Itemsget

OAuth

OAuth Clients

OpenID Connect

openid-providers

Performance

Review Evaluation by Employee
- Get the Employee's Evaluation in a Reviewget
- Update the Employee's Evaluation in a Reviewput
Trackers
KPI Configuration
Reviews
Review Configuration
Review Evaluation
Tracker Configuration
Tracker Logs
Review Evaluation by Supervisor
- Get the Supervisor's Evaluation in a Reviewget
- Update the Supervisor's Evaluation in a Reviewput

PIM

Custom Field
Employee Emergency Contact
Employee US Tax Exemption
- Get an Employee's US Tax Exemption Detailsget
- Update an Employee's US Tax Exemption Detailsput
Employee
Employee Language
Employee Licenses
Employee Report To
- List Available Employeesget
Employee Skill
Employee Attachment
Employee CSV Import
- Import Employee Recordspost
Employee Contact Details
- Get an Employee's Contact Detailsget
- Update an Employee's Contact Detailsput
Employee Count
- Get the Number of Employeesget
Employee Custom Field
- List an Employee's Custom Fieldsget
- Update an Employee's Custom Fieldsput
Employee Dependent
Employee Education
Employee Immigration
Employee Job Details
- Get an Employee's Job Detailsget
- Update an Employee's Job Detailsput
Employee Membership
Employee Personal Details
- Get an Employee's Personal Detailsget
- Update an Employee's Personal Detailsput
Employee Picture
- Get an Employee's Pictureget
- Update an Employee's Pictureput
Employee Salary
Employee Subordinates
Employee Supervisor
Employee Termination
Employee Work Experience
Employee Work Shift
- Get an Employee's Work Shiftget
Employment Contract
- Get an Employee's Employment Contractget
- Update an Employee's Employment Contractput
Optional Field
- Get Optional Field Configurationget
- Update Optional Field Configurationput
Defined Report
Reporting Method Configuration
Termination Reason Configuration
Update Password
- Update Passwordput
Employee Email Validation
- Validate an Employee's Work Emailget
- Validate an Employee's Other Emailget

Recruitment

Candidates
Candidate Workflow
Candidate Attachments
Candidate History
Candidate Interview
- Get a Candidate's Inteviewget
- Update a Candidate's Interviewput
Employee List
- List Employees Available for Interviewingget
Hiring Managers
- List Available Employees for Hiring Managerget
Interview Attachments
Vacancy
Vacancy Attachments

Time

Copy Project Activity
- List Copyable Activities Between Two Projectsget
- Copy Activities From One Projectpost
Customers
Default Timesheet
- Get Default Timesheetget
Employee Timesheet
My Timesheet
- List My Timesheet Entriesget
- Update My Timesheet Entriesput
Project
Project Activity
Project Admins
- List Available Employees for Project Adminget
Timesheet Period
- Get the Timesheet Periodget
- Update the Timesheet Periodput
Timesheet Report
- Get Time Reportsget
- Get Time Report Dataget
Timesheet Action Log
- Get a Timesheet's Action Logsget
Timesheet Comment
- Update a Timesheet Commentput
- Get a Timesheet Commentget
Validation
Timesheet Time Format
- Get Timesheet Time Formatget

Powered by

Get an Employee Directory Listing

get

https://{orangehrm-url}/api/v2/directory/employees/{empNumber}

Language

Credentials

OAuth2

Bearer

URL

Click Try It! to start a request and see the response here!