Skip to main content

API Documentation

Complete REST API documentation for IceHrm.

Overview​

IceHrm provides a REST API that allows you to integrate with external systems, build custom applications, and automate HR processes. The API exposes endpoints for managing employees, attendance, leave, and documents.

Base URL​

  • Open Source/Pro: http://your-icehrm-url.com/app/api
  • Cloud: https://icehrm.com/api/[instance-name]

Authentication​

IceHrm uses Bearer Token authentication. Include the token in the Authorization header with every request.

Authorization: Bearer [your-token]

Getting Your API Token​

  1. Log in to IceHrm
  2. Navigate to Personal Information -> Basic Information
  3. Click the Api Access tab
  4. Copy your API token

Request Format​

  • All requests should use Content-Type: application/json
  • Request bodies should be valid JSON

Response Format​

All responses return JSON with the following structure:

Success Response:

{
  "status": "SUCCESS",
  "data": { ... }
}

Error Response:

{
  "status": "ERROR",
  "message": "Error description"
}

HTTP Status Codes​

  • 200 OK: Successful request
  • 201 Created: Resource created successfully
  • 204 No Content: Successful with no response body
  • 400 Bad Request: Missing or invalid parameters
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: Access denied
  • 404 Not Found: Resource not found
  • 405 Method Not Allowed: HTTP method not supported

Available Endpoints​