v1

latestOpenAPI 3.1.02026-08-045901.5 MB

List Employee

This API functionality is used to fetch employee information. It is used in view profile page and in employee onboarding page

get/hr/employee

Query parameters

perpageinteger required

Number of records to display per page.

pageinteger required

Specifies which page of results to retrieve.

querystring

Used to search records by keyword or employee name.

fieldstring

Specifies the field name used for sorting or filtering, such as employee_id or employee_name

sortstring

Defines the sorting order — ASC for ascending or DESC for descending.

doj_startstring date

Start date for filtering employees by their date of joining.

doj_endstring date

End date for filtering employees by their date of joining.

statusinteger

Filters employee records based on their status such as Abscond (2), Resigned (4), Terminated (5), or Furlough (6).

attendance_statusinteger

Filters records by employee attendance status — 1 for Available and 2 for Not Available.

Headers

api-tokenstring

Generate token from authentication api

x-api-keystring

Response

200

statusinteger

msgstring

countinteger

statusCodestring

Example response

{
  "status": 1,
  "msg": "success",
  "data": [
    {
      "employee_id": "14",
      "name": "Final Testing",
      "designation": "testing",
      "department": "tech",
      "reporting_to": "3",
      "branchid": "9788453145",
      "doj": "2024-05-15",
      "office_email": "1712993177596-14@workid.global",
      "gid": 2047546361,
      "dob": "2000-09-30",
      "martial_status": "Unmarried",
      "gender": "Male",
      "personalnumber": 9898989867,
      "dateofexit": "2024-09-05",
      "employee_status": "Abscond",
      "status": "Not In Office",
      "supervisor": "Test",
      "branch": "NA"
    }
  ],
  "count": 1,
  "overallcount": {
    "total_employees": 29,
    "active_employees": 21,
    "abscond": 1,
    "resigned": 6,
    "furlough": 1
  },
  "statusCode": "200"
}