Endpoint: Data Santri & Tagihan

Daftar Santri

GET /api/v1/external/institutions/{slug}/students

Scope required: students:read

Query Parameters

Parameter	Tipe	Default	Keterangan
`page`	integer	1	Halaman
`per_page`	integer	20	Jumlah per halaman (maks. 100)
`search`	string	—	Cari berdasarkan nama atau NIS
`classroom_id`	uuid	—	Filter per kelas
`updated_since`	datetime (ISO 8601)	—	Hanya santri yang diubah sejak waktu ini — untuk sinkronisasi inkremental

Gunakan updated_since untuk sinkronisasi berkala tanpa harus menarik ulang seluruh data santri setiap kali. Simpan timestamp terakhir Anda melakukan sync, lalu kirim sebagai nilai updated_since pada request berikutnya. Format tanggal yang tidak valid akan diabaikan (request tetap berjalan tanpa filter ini, bukan error).

Response

{
  "data": [
    {
      "id": "uuid",
      "nis": "2024001",
      "name": "Ahmad Fauzi",
      "gender": "male",
      "classroom_id": "uuid",
      "status": "active"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 20,
    "total": 98
  },
  "message": "OK"
}

Gunakan classroom_id bersama endpoint Daftar Kelas untuk menampilkan santri terkelompok per kelas di sisi aplikasi Anda.

Tagihan Santri

GET /api/v1/external/institutions/{slug}/students/{student_id}/bills

Scope required: bills:read Mengambil seluruh tagihan SPP/biaya milik satu santri, beserta status pembayarannya.

Response

{
  "data": [
    {
      "id": "uuid",
      "bill_name": "SPP Bulan Juni 2026",
      "amount": 500000,
      "paid": 500000,
      "remaining": 0,
      "due_date": "2026-06-30",
      "status": "paid"
    },
    {
      "id": "uuid",
      "bill_name": "Biaya Kegiatan",
      "amount": 150000,
      "paid": 0,
      "remaining": 150000,
      "due_date": "2026-07-15",
      "status": "unpaid"
    }
  ],
  "message": "OK"
}

Nominal amount, paid, dan remaining belum termasuk kode unik 3 digit yang ditambahkan saat santri membayar via transfer bank. Lihat Manajemen SPP & Keuangan untuk detail sistem kode unik. amount adalah nominal akhir setelah diskon (jika ada) — paid + remaining selalu sama dengan amount.

Data Wali/Orang Tua Santri

GET /api/v1/external/institutions/{slug}/students/{student_id}/guardians

Scope required: guardians:read Mengambil seluruh data wali (ayah, ibu, atau wali lain) yang terdaftar untuk satu santri. Satu santri bisa memiliki lebih dari satu wali — endpoint ini mengembalikan semuanya, dengan wali utama (is_primary: true) muncul lebih dulu.

Response

{
  "data": [
    {
      "id": "uuid",
      "name": "Budi Santoso",
      "relation": "father",
      "phone": "081234567890",
      "email": "[email protected]",
      "occupation": "Wiraswasta",
      "address": "Jl. Merdeka No. 10, Bandung",
      "is_primary": true
    },
    {
      "id": "uuid",
      "name": "Siti Aminah",
      "relation": "mother",
      "phone": "081298765432",
      "email": null,
      "occupation": "Ibu Rumah Tangga",
      "address": "Jl. Merdeka No. 10, Bandung",
      "is_primary": false
    }
  ],
  "message": "OK"
}

Mengembalikan array kosong ("data": []) jika santri belum memiliki data wali tercatat — bukan error.

Integrasi API

Endpoint: Data Santri & Tagihan

Endpoint: Data Santri & Tagihan

Daftar Santri

Query Parameters

Response

Tagihan Santri

Response

Data Wali/Orang Tua Santri

Response

Langkah Berikutnya

​Endpoint: Data Santri & Tagihan

​Daftar Santri

​Query Parameters

​Response

​Tagihan Santri

​Response

​Data Wali/Orang Tua Santri

​Response

​Langkah Berikutnya

Endpoint: Data Santri & Tagihan

Daftar Santri

Query Parameters

Response

Tagihan Santri

Response

Data Wali/Orang Tua Santri

Response

Langkah Berikutnya