HRMS API API Documentation

Authentication

Pass your private API Key in the request headers:

X-API-Key: YOUR_API_KEY
Accept: application/json

Or via standard Bearer token: Authorization: Bearer YOUR_API_KEY

Available Plans & Quotas

Plan	Price	Rate Limit	Monthly Quota	Trial	Scopes
Free Trial	Free Trial	60 req/min	2,000	7 Days	`*`
Starter	USD 49.00/month	120 req/min	25,000	No	`employees:read, attendance:read, leave:read, leave:write, tasks:read`
Business	USD 149.00/month	300 req/min	100,000	No	`employees:, attendance:, leave:, payroll:read, payslips:read, tasks:, worklogs:*`
Enterprise	USD 399.00/month	1000 req/min	500,000	No	`*`

Documented Endpoints

GET /api/v1/hrms/employees

Scope: employees:read

List Company Employees

Returns a paginated list of company employees with department, designation, and employment status.

Parameters

Parameter	Type	Required	Description
`search`	string	No	Search by name, employee code, or email.
`department_id`	integer	No	Filter by department ID.
`status`	string	No	active, inactive, probation, terminated.

Example cURL Request

curl -X GET "https://hifisys.com/api/v1/hrms/employees?status=active" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Accept: application/json"

Sample 200 OK Response

{
    "success": true,
    "data": [
        {
            "id": 1,
            "employee_code": "EMP-001",
            "full_name": "Sarah Connor",
            "email": "sarah@example.com",
            "department": "Engineering",
            "designation": "Staff Engineer",
            "employment_status": "active"
        }
    ]
}

POST /api/v1/hrms/attendance/clock-in

Scope: attendance:write

Attendance Clock-In

Records employee punch-in timestamp, location coordinates/mode, and IP address.

Parameters

Parameter	Type	Required	Description
`employee_id`	integer	Yes	Unique employee identifier.
`work_mode`	string	No	office, remote, hybrid. Default: office.

Example cURL Request

curl -X POST "https://hifisys.com/api/v1/hrms/attendance/clock-in" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":1,"work_mode":"office"}'

Sample 200 OK Response

{
    "success": true,
    "message": "Clock-in recorded successfully at 09:00:00.",
    "data": {
        "attendance_id": 124,
        "clock_in": "2026-10-07 09:00:00"
    }
}