Karyawan API Documentation

Base URL: https://karyawan.imfar.id/api/v1

🏥 Health Check 👥 Get All Employees 🗑️ Get Deleted 🔍 Get by NIK ➕ Create Employee ✏️ Update Employee 🗂️ Soft Delete 🔄 Restore Employee 💀 Hard Delete 📊 Statistics 🏢 Get Divisions 📈 Summary by Division 📅 Summary by Year 🧑‍💼 Summary by PIC

GET /health

Health Check

▼

Check if the API server is running and healthy.

Response Example

{
  "success": true,
  "message": "Server is running",
  "timestamp": "2025-07-05T10:30:00.000Z",
  "environment": "production"
}

200 OK

GET /karyawan

Get All Employees

▼

Retrieve all active employees with pagination, search, and filtering.

Query Parameters

page integer

Page number (default: 1)

limit integer

Items per page (default: 10, max: 100)

search string

Search by name, NIK, or position

divisi string

Filter by division

include_deleted boolean

Include soft deleted records (default: false)

Response Example

{
  "success": true,
  "message": "Data karyawan berhasil diambil",
  "data": [
    {
      "nik": "EMP001",
      "nama_lengkap": "Budi Santoso",
      "tempat_lahir": "Jakarta",
      "tanggal_lahir": "1985-03-15",
      "jabatan": "Manager IT",
      "divisi": "Information Technology",
      "bekerja_sejak": "2018-05-01",
      "lama_bekerja": 7,
      "tanggal_awal_kontrak": "2018-05-01",
      "tanggal_akhir_kontrak": "2026-04-30",
      "sudah_punya_pic": true,
      "is_active": true,
      "created_at": "2025-07-05T10:30:00.000Z",
      "updated_at": "2025-07-05T10:30:00.000Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total": 18,
    "total_pages": 2,
    "has_next": true,
    "has_prev": false
  }
}

200 OK

400 Bad Request

GET /karyawan/deleted

Get Deleted Employees

▼

Retrieve all soft deleted employees.

Query Parameters

page integer

Page number (default: 1)

limit integer

Items per page (default: 10, max: 100)

search string

Search by name, NIK, or position

200 OK

400 Bad Request

GET /karyawan/{nik}

Get Employee by NIK

▼

Retrieve a specific employee by their NIK.

Path Parameters

nik string required

Employee NIK identifier

Query Parameters

include_deleted boolean

Include soft deleted records (default: false)

200 OK

404 Not Found

POST /karyawan

Create New Employee

▼

Create a new employee record.

Request Body (JSON)

nik string required

Unique employee identifier (max 20 chars)

nama_lengkap string required

Full name (max 100 chars)

tempat_lahir string required

tanggal_lahir date required

Format: YYYY-MM-DD

jabatan string required

divisi string required

sudah_punya_pic boolean required

Request Example

{
  "nik": "EMP021",
  "nama_lengkap": "John Doe",
  "tempat_lahir": "Jakarta",
  "tanggal_lahir": "1990-01-01",
  "jabatan": "Software Developer",
  "divisi": "Information Technology",
  "bekerja_sejak": "2023-01-01",
  "lama_bekerja": 2,
  "tanggal_awal_kontrak": "2023-01-01",
  "tanggal_akhir_kontrak": "2025-12-31",
  "sudah_punya_pic": true
}

201 Created

400 Bad Request

409 NIK Exists

PUT /karyawan/{nik}

Update Employee

▼

Update an existing employee record.

Path Parameters

nik string required

Employee NIK identifier

200 OK

404 Not Found

400 Bad Request

DELETE /karyawan/{nik}

Soft Delete Employee

▼

Soft delete an employee (sets is_active = false). Data can be restored later.

Path Parameters

nik string required

Employee NIK identifier

200 OK

404 Not Found

PUT /karyawan/{nik}/restore

Restore Employee

▼

Restore a soft deleted employee (sets is_active = true).

Path Parameters

nik string required

Employee NIK identifier

200 OK

400 Already Active

404 Not Found

DELETE /karyawan/{nik}/hard

Hard Delete Employee

▼

⚠️ WARNING: Permanently delete an employee from database. This action cannot be undone!

Path Parameters

nik string required

Employee NIK identifier

200 OK

404 Not Found

GET /karyawan/statistics

Get Statistics

▼

Get overall statistics and analytics data.

Response Example

{
  "success": true,
  "message": "Statistik berhasil diambil",
  "data": {
    "total_karyawan_aktif": 18,
    "total_karyawan_deleted": 2,
    "by_divisi": [
      {
        "divisi": "Information Technology",
        "jumlah": 5
      }
    ],
    "by_pic_status": [
      {
        "sudah_punya_pic": 1,
        "jumlah": 12
      }
    ],
    "kontrak_berakhir_6_bulan": 8,
    "by_status": [
      {
        "status": "Aktif",
        "jumlah": 18
      }
    ]
  }
}

200 OK

GET /karyawan/divisi

Get All Divisions

▼

Get list of all available divisions.

200 OK

GET /karyawan/summary/by-divisi

Summary by Division

▼

Get employee count per division, separated by active and inactive status.

Response Example

{
  "success": true,
  "message": "Data karyawan per divisi berhasil diambil",
  "data": [
    {
      "divisi": "Human Resources",
      "active_count": 5,
      "inactive_count": 1
    },
    {
      "divisi": "Information Technology",
      "active_count": 10,
      "inactive_count": 2
    }
  ]
}

200 OK

500 Internal Server Error

GET /karyawan/summary/by-tahun-kontrak

Summary by Contract Year

▼

Get the number of contracts created per year.

Response Example

{
  "success": true,
  "message": "Data karyawan per tahun kontrak berhasil diambil",
  "data": [
    {
      "tahun_kontrak": 2020,
      "jumlah_karyawan": 8
    },
    {
      "tahun_kontrak": 2021,
      "jumlah_karyawan": 12
    }
  ]
}

200 OK

500 Internal Server Error

GET /karyawan/summary/by-pic-status

Summary by PIC Status

▼

Get the number of active employees who have a PIC and who do not.

Response Example

{
  "success": true,
  "message": "Data status PIC karyawan berhasil diambil",
  "data": {
    "sudah_punya_pic": 15,
    "belum_punya_pic": 3
  }
}

200 OK

500 Internal Server Error