Jump to Content
API Reference
v2.5.0
v2.6.0
v2.7.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
OrangeHRM Starter 5.7
API Reference
List the Buzz Feed
Search
JUMP TO
Documentation
Getting Started
Authorization
Registering a Client
Generating a Code Verifier
Obtaining an Access Token
Refreshing an Access Token
Common Auth Error Responses
API Usage
Pagination
Sorting
Common API Error Responses
Try It Yourself!
Admin
Education
Get an Education Record
get
Update an Education Record
put
List All Education Records
get
Create an Education Record
post
Delete Education Records
delete
Email Configuration
Get Email Configuration
get
Update Email Configuration
put
Email Subscriber
List All Email Subscribers
get
Create an Email Subscriber
post
Delete Email Subscribers
delete
Get an Email Subscriber
get
Update an Email Susbcriber
put
Email Subscription
List All Email Subscriptions
get
Update an Email Subscription
put
Employment Status
Get an Employment Status
get
Update an Employment Status
put
List All Employment Statuses
get
Create an Employment Status
post
Delete Employment Statuses
delete
I18N
List All I18N Groups
get
List I18N Import Errors
get
List All I18N Languages
get
Delete an I18N Language
delete
Get an I18N Language
get
Update an I18N Language
put
List All I18N Translations
get
Bulk Update I18N Translations
put
Validate I18N Translation
get
I18N Language Import
Import I18N language
post
Job Category
Get a Job Category
get
Update a Job Category
put
List All Job Categories
get
Create a Job Category
post
Delete Job Categories
delete
Job Specification
Get Job Specification
get
Job Title
Get a Job Title
get
Update a Job Title
put
List All Job Titles
get
Create a Job Title
post
Delete Job Titles
delete
Languages
Get a Language Record
get
Update a Language Record
put
List All Languages Records
get
Create a Language Record
post
Delete Language Records
delete
License
Get a License
get
Update a License
put
List All Licenses
get
Create a License
post
Delete Licenses
delete
Localization
Get Localization Settings
get
Update Localization Settings
put
Locations
Get a Location
get
Update a Location
put
List All Locations
get
Create a Location
post
Delete Locations
delete
Memberships
Get a Membership
get
Update a Membership
put
List All Memberships
get
Create a Membership
post
Delete Memberships
delete
Modules
List All Modules
get
Update a Module
put
Nationality
Get a Nationality
get
Update a Nationality
put
List All Nationalities
get
Create a Nationality
post
Delete Nationalities
delete
Organization
Get Organization Details
get
Update Organization Details
put
Pay Grade
List All Pay Grades
get
Create a Pay Grade
post
Delete Pay Grades
delete
Get a Pay Grade
get
Update a Pay Grade
put
Pay Grade Currency
List Allowed Currencies for Pay Grade
get
Get a Pay Grade Currency
get
Update a Pay Grade Currency
put
List All Pay Grade Currencies
get
Create a Pay Grade Currency
post
Delete Pay Grade Currencies
delete
Skills
Get a Skill
get
Update a Skill
put
List All Skills
get
Create a Skill
post
Delete Skills
delete
Subunits
Get a Subunit
get
Update a Subunit
put
Delete Subunits
delete
List All Subunits
get
Create a Subunit
post
Users
Get a User
get
Update a User
put
List All Users
get
Create a User
post
Delete Users
delete
Validate Username Uniqueness
get
Work Shift
List All Work Shifts
get
Create a Work Shift
post
Delete Work Shifts
delete
Get a Work Shift
get
Update a Work Shift
put
List Employees Unassigned to Work Shift
get
Theme
Preview Theme
post
Get Theme Details
get
Edit Theme
put
Reset Theme
delete
LDAP Configuration
Get LDAP Configuration
get
Update LDAP Configuration
put
Test LDAP Connection
post
LDAP User Sync
Get User Sync Details
get
Sync LDAP User
post
Attendance
Configuration
Get Attendance Configuration
get
Update Attendance Configuration
put
Overlap
Check Punch In Overlap (Editing)
get
Check Punch Out Overlap (Editing)
get
Check Punch In Overlap
get
Check Punch Out Overlap
get
Attendance Record
List an Attendance Record
get
Update an Attendance Record
put
Get the Latest Attendance Record
get
Current Date Time
Get the Current Date & Time
get
Employee Attendance
List an Employee's Attendance Records
get
Update an Employee's Attendance Record
put
Create an Employee's Attendance Record
post
Delete an Employee's Attendance Records
delete
Employee Attendance Summary
Summarize Employee Attendance
get
Timezones
List Timezones
get
Buzz
Comments
Get a Comment on a Post
get
Edit a Comment on a Post
put
Delete a Comment on a Post
delete
List All Comments on a Post
get
Comment on a Post
post
Feed
List the Buzz Feed
get
Comment Likes
List Likes on a Comment
get
Like a Comment
post
Unlike a Liked Comment
delete
Share Likes
List Likes on a Share/Post
get
Like a Share/Post
post
Unlike a Liked Share/Post
delete
Post
Post Text, Photos or Video
post
Get a Post
get
Edit a Post
put
Shares
List All Shares of a Post
get
Share a Post
post
Edit a Share
put
Delete a Share
delete
Validation
Validate Video Link
get
Employee Anniversary
List Upcoming Employee Anniversaries
get
Claim
Attachments
List Attachements on a Claim
get
Add Attachments to a Claim
post
Remove Attachments from a Claim
delete
View an Attachment on a Claim
get
Update an Attachment on a Claim
put
Events
List All Claim Events
get
Create a Claim Event
post
Delete Claim Events
delete
Get a Claim Event
get
Update a Claim Event
put
Expenses
List All Expenses from a Claim
get
Add an Expense to a Claim
post
Remove an Expense from a Claim
delete
Get an Expense from a Claim
get
Update an Expense from a Claim
put
Expense Types
List All Expense Types
get
Create an Expense Type
post
Delete Expense Types
delete
Get an Expense Type
get
Update an Expense Type
put
Requests
Perform an Action on a Claim Request
put
List an Employee's Claim Requests
post
List All Claim Requests
get
Get an Employee's Claim Request
get
My Requests
List My Claim Requests
get
Create My Claim Request
post
Get My Claim Request
get
Core
About Organization
Get Basic Organization Details
get
Unique Validation
Validate Uniqueness
get
Dashboard
Widgets
Get My Action Summary
get
Get Employee Distribution by Location
get
Get Employee Distribution by Sub Unit
get
Get Employees on Leave Today
get
Get Employees on Leave Today Configuration
get
Configure Employees on Leave Today
put
Get My Time at Work
get
Get Quick Launch Shortcuts
get
Directory
Employees
Get an Employee Directory Listing
get
Get the Employee Directory
get
Leave
Employee Bulk Leave
Bulk Approve/Cancel/Reject Leaves
put
Leave Type
Get My Eligible Leave Types
get
Get a Leave Type
get
Update a Leave Type
put
List All Leave Types
get
Create a Leave Type
post
Delete Leave Types
delete
Employee Bulk Leave Request
Bulk Approve/Cancel/Reject Leave Requests
put
Employee Leave
List All Employee Leaves
get
Leave Balance
Get an Employee's Leave Balance
get
Get Leave Balance for a Leave Type
get
Entitlements
Get an Employee's Leave Entitlement
get
List an Employee's Leave Entitlements
get
Get a Leave Entitlement
get
Update a Leave Entitlement
put
List All Leave Entitlements
get
Assign Leave Entitlements to Employees
post
Delete Leave Entitlements
delete
Employee Leave Request
Get a Leave Request
get
Update a Leave Request
put
List All Leave Requests
get
Create a Leave Request
post
Holiday
Get a Holiday
get
Update a Holiday
put
List All Holidays
get
Create a Holiday
post
Delete Holidays
delete
Leaves
List All Leaves in a Leave Request
get
Update a Leave
put
Leave Comment
List All Comments for a Leave
get
Comment on a Leave
post
Overlap Leave
Get Overlapping Leaves
get
Leave Period
Get Current Leave Period
get
Update Leave Period
put
List All Leave Periods
get
Leave Report
Get Leave Report
get
Get Leave Report Data
get
Leave Request Comment
List Comments for a Leave Request
get
Comment on a Leave Request
post
My Leave Request
Get My Leave Request
get
Update my Leave Request
put
List My Leave Requests
get
Apply for Leave
post
Validation
Validate Leave Entitlement
get
Work Week
Get Work Week
get
Update Work Week
put
Maintenance
Purge Candidate
Purge Candidate
delete
List Purgeable Candidates for a Vacancy
get
Purge Employee
Purge Employee
delete
Mobile
Menu Items
List Mobile Menu Items
get
OAuth
OAuth Clients
List All OAuth Clients
get
Create an OAuth Client
post
Delete OAuth Clients
delete
Get an OAuth Client
get
Update an OAuth Client
put
OpenID Connect
openid-providers
List All OpenID Providers
get
Create OpenID Provider
post
Update OpenID Providers
delete
Get an OpenID Provider
get
Update a OpenID Provider
put
Performance
Review Evaluation by Employee
Get the Employee's Evaluation in a Review
get
Update the Employee's Evaluation in a Review
put
Trackers
List All Employee Trackers
get
Get an Employee Tracker
get
List My Performance Trackers
get
KPI Configuration
Get a KPI
get
Update a KPI
put
List All KPIs
get
Create a KPI
post
Delete KPIs
delete
Reviews
List My Reviews
get
Get Allowed Actions for Review
get
List All Reviews
get
Review Configuration
List All Performance Reviews
get
Create a Performance Review
post
Delete Performance Reviews
delete
Get a Performance Review
get
Update a Performance Review
put
List an Employee's Supervisors
get
Review Evaluation
Get a Finalized Performance Review
get
Finalize Performance Review
put
List KPIs for a Review
get
Tracker Configuration
List All Performance Trackers
get
Create a Performance Tracker
post
Delete Performance Trackers
delete
Get a Performance Tracker
get
Update a Performance Tracker
put
List All Available Tracker Reviewers
get
Tracker Logs
List Logs for a Performance Tracker
get
Create a Log for a Performance Tracker
post
Remove Logs from a Performance Tracker
delete
Get a Log from a Performance Tracker
get
Update a Log from a Performance Tracker
put
Review Evaluation by Supervisor
Get the Supervisor's Evaluation in a Review
get
Update the Supervisor's Evaluation in a Review
put
PIM
Custom Field
Get a Custom Field
get
Update a Custom Field
put
List All Custom Fields
get
Create a Custom Field
post
Delete Custom Fields
delete
Employee Emergency Contact
List an Employee's Emergency Contacts
get
Add an Emergency Contact to an Employee
post
Delete an Employee's Emergency Contacts
delete
Get an Employee's Emergency Contact
get
Update an Employee's Emergency Contact
put
Employee US Tax Exemption
Get an Employee's US Tax Exemption Details
get
Update an Employee's US Tax Exemption Details
put
Employee
Get an Employee
get
List All Employees
get
Create an Employee
post
Delete Employees
delete
Get My Details
get
Employee Language
List Allowed Languages for an Employee
get
Get an Employee's Language and Fluency
get
Update an Employee's Language and Fluency
put
List an Employee's Languages
get
Add a Language to an Employee
post
Delete an Employee's Languages
delete
Employee Licenses
List Allowed Licenses for an Employee
get
Get an Employee's License
get
Update an Employee's License
put
List an Employee's Licenses
get
Add a License to an Employee
post
Delete an Employee's Licenses
delete
Employee Report To
List Available Employees
get
Employee Skill
List Allowed Skills for an Employee
get
Get an Employee's Skill
get
Update an Employee's Skill
put
List an Employee's Skills
get
Add a Skill to an Employee
post
Delete an Employee's Skills
delete
Employee Attachment
Get an Employee's Attachment on a Screen
get
Update an Employee's Attachment on a Screen
put
List an Employee's Attachments on a Screen
get
Add an Attachment to an Employee on a Screen
post
Delete an Employee's Attachments on a Screen
delete
Employee CSV Import
Import Employee Records
post
Employee Contact Details
Get an Employee's Contact Details
get
Update an Employee's Contact Details
put
Employee Count
Get the Number of Employees
get
Employee Custom Field
List an Employee's Custom Fields
get
Update an Employee's Custom Fields
put
Employee Dependent
Get an Employee's Dependent
get
Update an Employee's Dependent
put
List an Employee's Dependents
get
Add a Dependent to an Employee
post
Delete an Employee's Dependents
delete
Employee Education
Get an Employee's Educational Qualification
get
Update an Employee's Educational Qualification
put
List an Employee's Educational Qualifications
get
Add an Educational Qualification to an Employee
post
Delete an Employee's Educational Qualifications
delete
Employee Immigration
List an Employee's Immigration Record
get
Add an Immigration Record to an Employee
post
Delete an Employee's Immigration Records
delete
Get an Employee's Immigration Record
get
Update an Employee's Immigration Record
put
Employee Job Details
Get an Employee's Job Details
get
Update an Employee's Job Details
put
Employee Membership
Get an Employee's Membership
get
Update an Employee's Membership
put
List an Employee's Memberships
get
Add a Membership to an Employee
post
Delete an Employee's Memberships
delete
Employee Personal Details
Get an Employee's Personal Details
get
Update an Employee's Personal Details
put
Employee Picture
Get an Employee's Picture
get
Update an Employee's Picture
put
Employee Salary
Get an Employee's Salary Component
get
Update an Employee's Salary Component
put
List an Employee's Salary Components
get
Add a Salary Component to an Employee
post
Delete an Employee's Salary Components
delete
Employee Subordinates
List an Employee's Subordinates
get
Add a Subordinate to an Employee
post
Delete an Employee's Subordinates
delete
Get an Employee's Subordinate
get
Update an Employee's Subordinate
put
Update an Employee's Supervisor
put
Employee Supervisor
Get an Employee's Supervisor
get
List an Employee's Supervisors
get
Add a Supervisor to an Employee
post
Delete an Employee's Supervisors
delete
Employee Termination
Get an Employee's Termination Record
get
Update an Employee's Termination Record
put
Terminate an Employee
post
Delete an Employee's Termination Record
delete
Employee Work Experience
Get an Employee's Work Experience Record
get
Update an Employee's Work Experiece Record
put
List Employee's Work Experience Records
get
Add a Work Experience Record to an Employee
post
Delete an Employee's Work Experience Records
delete
Employee Work Shift
Get an Employee's Work Shift
get
Employment Contract
Get an Employee's Employment Contract
get
Update an Employee's Employment Contract
put
Optional Field
Get Optional Field Configuration
get
Update Optional Field Configuration
put
Defined Report
List All PIM Reports
get
Create a PIM Report
post
Delete PIM Reports
delete
Update a PIM Report
put
Reporting Method Configuration
Get a Reporting Method
get
Update a Reporting Method
put
List All Reporting Methods
get
Create a Reporting Method
post
Delete Reporting Methods
delete
Termination Reason Configuration
List All Termination Reasons
get
Create a Termination Reason
post
Delete Termination Reasons
delete
Get a Termination Reason
get
Update a Termination Reason
put
Update Password
Update Password
put
Employee Email Validation
Validate an Employee's Work Email
get
Validate an Employee's Other Email
get
Recruitment
Candidates
List All Candidates
get
Create a Candidate
post
Delete Candidates
delete
Get a Candidate
get
Update a Candidate
put
List All Statuses
get
Candidate Workflow
Get Allowed Actions for Candidate
get
Hire Candidate
put
Schedule Interview for a Candidate
post
Offer Job to Candidate
put
Mark Candidate Interview as Failed
put
Mark Candidate Interview as Passed
put
Decline Job Offer for Candidate
put
Reject Candidate
put
Shortlist Candidate
put
Candidate Attachments
Add an Attachment to a Candidate
post
Get a Candidate's Attachment
get
Update a Candidate's Attachment
put
Candidate History
List a Candidate's History
get
Get a Candidate's History Record
get
Update a Candidate's History Record
put
Candidate Interview
Get a Candidate's Inteview
get
Update a Candidate's Interview
put
Employee List
List Employees Available for Interviewing
get
Hiring Managers
List Available Employees for Hiring Manager
get
Interview Attachments
List All Interview Attachments
get
Add an Attachment to an Interview
post
Delete Interview Attachments
delete
Get an Interview Attachment
get
Update an Interview Attachment
put
Vacancy
Get a Vacancy
get
Update a Vacancy
put
List All Vacancies
get
Create a Vacancy
post
Delete Vacancies
delete
Vacancy Attachments
Add an Attachment to a Vacancy
post
Delete Vacancy Attachments
delete
Get a Vacancy Attachment
get
Update a Vacancy Attachment
put
Time
Copy Project Activity
List Copyable Activities Between Two Projects
get
Copy Activities From One Project
post
Customers
List All Customers
get
Create a Customer
post
Delete Customers
delete
Get a Customer
get
Update a Customer
put
Default Timesheet
Get Default Timesheet
get
Employee Timesheet
List an Employee's Timesheets
get
Create a Timesheet for an Employee
post
Update an Employee's Timesheet
put
Get a Timesheet's Entries
get
Update a Timesheet's Entries
put
List All Employee Timesheets
get
My Timesheet
List My Timesheet Entries
get
Update My Timesheet Entries
put
Project
List All Projects
get
Crete a Project
post
Delete Projects
delete
Get a Project
get
Update a Project
put
Project Activity
List a Project's Activities
get
Add an Activity to a Project
post
Delete a Project's Activities
delete
Get a Project's Activity
get
Update a Project's Activity
put
Project Admins
List Available Employees for Project Admin
get
Timesheet Period
Get the Timesheet Period
get
Update the Timesheet Period
put
Timesheet Report
Get Time Reports
get
Get Time Report Data
get
Timesheet Action Log
Get a Timesheet's Action Logs
get
Timesheet Comment
Update a Timesheet Comment
put
Get a Timesheet Comment
get
Validation
Validate Project Acitvity Uniqueness in Timesheet
get
Validate Project Name Uniqueness
get
Validate Customer Name Uniqueness
get
Validate Project Activity Name Uniqueness
get
Timesheet Time Format
Get Timesheet Time Format
get
Powered by
List the Buzz Feed
get
https://{orangehrm-url}/api/v2/buzz/feed
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Bearer
URL
Base URL
https://
opensource-demo.orangehrmlive.com/web/index.php
/api/v2/buzz/feed
RESPONSE
Click
Try It!
to start a request and see the response here!
