---
title: "List Employee"
method: GET
path: "/hr/employee"
---

# List Employee

`GET /hr/employee`

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

## Query parameters

- `perpage` integer, required
- `page` integer, required
- `query` string
- `field` string
- `sort` string
- `doj_start` string, date
- `doj_end` string, date
- `status` integer
- `attendance_status` integer

## Headers

- `api-token` string
- `x-api-key` string

## Response `200`

200

- object
  - `status` integer
  - `msg` string
  - `data` object[]
    - `employee_id` string
    - `name` string
    - `designation` string
    - `department` string
    - `reporting_to` string
    - `branchid` string
    - `doj` string
    - `office_email` string
    - `officemobile` integer
    - `gid` integer
    - `dob` string
    - `bloodgroup` string
    - `martial_status` string
    - `gender` string
    - `personalnumber` integer
    - `dateofexit` string
    - `salary_setup` integer
    - `employee_status` string
    - `regime` unknown
    - `ptexemptions` unknown
    - `status` string
    - `supervisor` string
    - `branch` string
  - `count` integer
  - `overallcount` object
    - `total_employees` integer
    - `active_employees` integer
    - `inactive_employees` integer
    - `abscond` integer
    - `resigned` integer
    - `terminated` integer
    - `furlough` integer
  - `statusCode` string

## Other responses

- `401` — 401
- `502` — 502
- `503` — 503

---

[API](https://skmtc.dev/ledgers/apis/authentication.md) · [All operations](https://skmtc.dev/ledgers/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ledgers/authentication/revisions/605f28ef08ef/schema)