API Docs

Developer Docs

HRflix REST API

JIntegrate employee data, trigger payroll, sync attendance and automate workflows with our clean, well-documented API.

REST + JSON

Standard REST API with JSON responses. SDKs available for Node.js, Python, Ruby and PHP.

OAuth 2.0

Secure authentication with OAuth 2.0 bearer tokens. API keys also supported for server-to-server use.

Webhooks

Subscribe to real-time events: employee.joined, payroll.processed, leave.approved and 40+ more.

Basae URL

https://api.hrflix.in/v1

Authentication

All API requests must include your Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY Content-Type: application/json
Endpoints

GET /employees

Returns a paginated list of all employees in your organisation.

// Request GET /v1/employees?page=1&limit=50&status=active // Response 200 OK { "data": [ { "id": "emp_01HV...", "name": "Arjun Kapoor", "department": "Engineering", "status" : "active", "joining_date": "2024-01-15" } ], "meta": { "total": 247, "page": 1 } } Authorization: Bearer YOUR_API_KEY Content-Type: application/json

POST /payroll/run

Trigger a payroll run for a given month.

// Request POST /v1/payroll/run { "month": "2026-03", "department_ids" : ["all"], "dry_run": false } // Response 202 Accepted { "job_id": "prn_01HX...", "status": "queued", "estimated_completion": "2026-03-24T14:32:00Z" }

GET /attendance/summary

Fetch attendance summary for an employee or team for a date range.

GET /v1/attendance/summary?employee_id=emp_01HV&from=2026-03-01&to=2026-03-31

Rate Limits

API requests are rate-limited per plan:

Starter: 1,000 requests/hour
Growth: 10,000 requests/hour
Enterprise: Unlimited (with SLA)

SDKs

# Node.js npm install @HRflix/sdk # Python pip install HRflix # Ruby gem instal HRflix