Attendance
get
GET Attendance Entry
post
Create Attendance Entry
get
GET All Attendance
post
Employee Punch In
del
Delete Attendance Entry
get
GET All Attendance for Employee
get
Retrieve Open Punch In
post
Employee Punch Out
Employees
get
GET Employee Educations
get
GET Employee Languages
get
Get Me
get
GET Employee Skills
get
GET Employee Status
post
Employee Status
get
GET Employee Certifications
get
GET All Employees
post
Create Employee
get
GET Employee
del
Delete Employee
put
Edit Employee
Directory
get
Staff
Leave
get
Get All Leave
get
Leave Entitlement
get
Check Leave
get
Get Leave Details
post
Upload Leave Attachment
post
Apply
Meta
get
Countries
get
CurrencyTypes
get
Get Mobile Modules
Expense
get
Expense Categories
get
My Expenses
get
Expense Payment Methods
post
Upload Expense Attachment
post
Add Expense
Charts
get
Employees online
get
Employee Distribution
get
Company leave entitlement
Tasks
get
Tasks
Recruitment
get
GET All Active Jobs
get
GETJob
get
GET Candidate
get
GET Candidate Notes
get
GET Candidate Interviews
API docs by Redocly
IceHrmProApi
(1.0.0)
Download OpenAPI specification:
Download
Attendance
GET Attendance Entry
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/attendance/1
http://{{baseurl}}
/attendance/1
Create Attendance Entry
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Request Body schema:
*/*
string
Responses
200
Successful response
post
/attendance
http://{{baseurl}}
/attendance
GET All Attendance
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/attendance
http://{{baseurl}}
/attendance
Employee Punch In
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Request Body schema:
*/*
string
Responses
200
Successful response
post
/attendance/punch-in
http://{{baseurl}}
/attendance/punch-in
Delete Attendance Entry
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
delete
/attendance/69
http://{{baseurl}}
/attendance/69
GET All Attendance for Employee
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employee/3/attendance
http://{{baseurl}}
/employee/3/attendance
Retrieve Open Punch In
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employee/1/open-punch-in/today
http://{{baseurl}}
/employee/1/open-punch-in/today
Employee Punch Out
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Request Body schema:
*/*
string
Responses
200
Successful response
post
/attendance/punch-out
http://{{baseurl}}
/attendance/punch-out
Employees
GET Employee Educations
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employees/1/educations
http://{{baseurl}}
/employees/1/educations
GET Employee Languages
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employees/1/languages
http://{{baseurl}}
/employees/1/languages
Get Me
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employees/me
http://{{baseurl}}
/employees/me
GET Employee Skills
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employees/1/skills
http://{{baseurl}}
/employees/1/skills
GET Employee Status
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employees/1/status
http://{{baseurl}}
/employees/1/status
Employee Status
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Request Body schema:
*/*
string
Responses
200
Successful response
post
/employees/1/status
http://{{baseurl}}
/employees/1/status
GET Employee Certifications
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employees/1/certifications
http://{{baseurl}}
/employees/1/certifications
GET All Employees
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employees
http://{{baseurl}}
/employees
Create Employee
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Content-Type
string
Example:
application/json
Request Body schema:
*/*
string
Responses
200
Successful response
post
/employees
http://{{baseurl}}
/employees
GET Employee
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/employees/1
http://{{baseurl}}
/employees/1
Delete Employee
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Content-Type
string
Example:
application/json
Responses
200
Successful response
delete
/employees/44
http://{{baseurl}}
/employees/44
Edit Employee
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Content-Type
string
Example:
application/json
Request Body schema:
*/*
string
Responses
200
Successful response
put
/employees/46
http://{{baseurl}}
/employees/46
Directory
Staff
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/staff
http://{{baseurl}}
/staff
Leave
Get All Leave
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/leave
http://{{baseurl}}
/leave
Leave Entitlement
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/leave/entitlement
http://{{baseurl}}
/leave/entitlement
Check Leave
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/leave/check/1/2019-02-15/2019-02-15
http://{{baseurl}}
/leave/check/1/2019-02-15/2019-02-15
Get Leave Details
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/leave/2
http://{{baseurl}}
/leave/2
Upload Leave Attachment
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Request Body schema:
multipart/form-data
file
string
<binary>
Responses
200
Successful response
post
/leave/file-upload
http://{{baseurl}}
/leave/file-upload
Apply
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Request Body schema:
*/*
string
Responses
200
Successful response
post
/leave/apply
http://{{baseurl}}
/leave/apply
Meta
Countries
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/meta/countries
http://{{baseurl}}
/meta/countries
CurrencyTypes
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/meta/currency
http://{{baseurl}}
/meta/currency
Get Mobile Modules
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/meta/mobile-modules
http://{{baseurl}}
/meta/mobile-modules
Expense
Expense Categories
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/expense/categories
http://{{baseurl}}
/expense/categories
My Expenses
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/expenses
http://{{baseurl}}
/expenses
Expense Payment Methods
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/expense/payment-methods
http://{{baseurl}}
/expense/payment-methods
Upload Expense Attachment
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Content-Type
string
Example:
application/x-www-form-urlencoded
Request Body schema:
multipart/form-data
file
string
<binary>
Responses
200
Successful response
post
/expenses/file-upload
http://{{baseurl}}
/expenses/file-upload
Add Expense
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Request Body schema:
*/*
string
Responses
200
Successful response
post
/expense
http://{{baseurl}}
/expense
Charts
Employees online
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/charts/employee-check-ins
http://{{baseurl}}
/charts/employee-check-ins
Employee Distribution
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/charts/employees-distribution
http://{{baseurl}}
/charts/employees-distribution
Company leave entitlement
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/charts/company-leave-entitlement
http://{{baseurl}}
/charts/company-leave-entitlement
Tasks
Tasks
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/tasks
http://{{baseurl}}
/tasks
Recruitment
GET All Active Jobs
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/jobs
http://{{baseurl}}
/jobs
GETJob
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/job/9
http://{{baseurl}}
/job/9
GET Candidate
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/candidate/18
http://{{baseurl}}
/candidate/18
GET Candidate Notes
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/candidate/18/notes
http://{{baseurl}}
/candidate/18/notes
GET Candidate Interviews
header Parameters
Authorization
string
Example:
Bearer {{accessToken}}
Responses
200
Successful response
get
/candidate/18/interviews
http://{{baseurl}}
/candidate/18/interviews