HRConnect REST API

The HRConnect REST API provides programmatic access to all HRConnect resources. You can use the API to integrate HRConnect with your existing systems, build custom workflows, and automate HR processes.

Authentication

The HRConnect API uses API keys to authenticate requests. You can view and manage your API keys in the HRConnect dashboard.

Error Handling

The HRConnect API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided, and codes in the 5xx range indicate an error with our servers.

Error Response Format

When an error occurs, the API will return a JSON response with an error object containing details about the error.

{
  "error": {
    "code": "invalid_request",
    "message": "The request was unacceptable, often due to missing a required parameter.",
    "param": "email",
    "type": "validation_error"
  }
}

Rate Limits

The HRConnect API implements rate limiting to protect our infrastructure and ensure fair usage. Rate limits vary based on your plan.

Rate limit headers are included in all API responses:

• X-RateLimit-Limit: The maximum number of requests you're permitted to make per minute.
• X-RateLimit-Remaining: The number of requests remaining in the current rate limit window.
• X-RateLimit-Reset: The time at which the current rate limit window resets in UTC epoch seconds.

Pagination

All list endpoints support pagination using the page and limit query parameters.

GET /api/v1/employees?page=2&limit=10

The response will include pagination metadata:

{
  "data": [...],
  "pagination": {
    "total": 125,
    "page": 2,
    "limit": 10,
    "pages": 13,
    "prev": 1,
    "next": 3
  }
}

API Versioning

The HRConnect API is versioned to ensure backward compatibility as we evolve the API. The current version is v1.

All API requests should include the version in the URL path:

https://api.hrconnect.com/api/v1/employees

We will notify you well in advance of any breaking changes or deprecations to the API.

The Employees API allows you to manage employee data, including personal information, job details, and more.

The Attendance API allows you to track employee attendance, including clock-in and clock-out times, and generate attendance reports.

The Leaves API allows you to manage employee leave requests, approvals, and leave balances.

The Payroll API allows you to manage payroll periods, calculate payroll, and generate payslips.

The Reports API allows you to generate various HR reports, including attendance, leave, payroll, and employee turnover reports.