We use cookies to enhance your experience on our website. Some are essential for the site to function, while others help us understand how you use the site.
Search across all modules, people, and actions
Comprehensive Integration Guide for AqlHR Platform
https://api.aqlhr.ai/v1All API requests use this base URL
application/jsonAll requests and responses are in JSON format
TLS 1.3All communications encrypted with TLS 1.3
{
"success": true,
"data": {
"employees": [
{
"id": "emp_123",
"nameAr": "أحمد محمد",
"nameEn": "Ahmed Mohammed",
"email": "[email protected]",
"department": "Engineering",
"position": "Senior Developer",
"status": "active",
"joinDate": "2024-01-15",
"createdAt": "2024-01-15T08:00:00Z",
"updatedAt": "2024-01-20T14:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 150,
"totalPages": 8
}
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2024-01-25T10:30:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
},
"meta": {
"requestId": "req_xyz789",
"timestamp": "2024-01-25T10:30:00Z"
}
}| Code | Status | Description |
|---|---|---|
| 200 | OK | Request succeeded |
| 201 | Created | Resource created successfully |
| 400 | Bad Request | Invalid request parameters |
| 401 | Unauthorized | Authentication required |
| 403 | Forbidden | Access denied |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server error |