Panduan Referensi API
Memulai
Untuk mulai menggunakan API, kami sarankan menggunakan alat untuk menguji API. Bruno dan Postman sama-sama bagus untuk mencoba permintaan API dan menyempurnakan alur kerja Anda sebelum mulai memprogram.
Memulai dengan Bruno
Untuk memulai, Anda perlu mengunduh dan menginstal Bruno. Bruno adalah alat sumber terbuka yang bagus untuk mencoba permintaan API dan menyempurnakan alur kerja Anda sebelum mulai memprogram.

Kunci API dapat dibuat di Portal Pengaturan API
Memulai dengan Postman
Untuk memulai, Anda perlu mengunduh dan menginstal Postman. Postman adalah alat yang bagus untuk mencoba permintaan API dan menyempurnakan alur kerja Anda sebelum mulai memprogram.

Kunci API dapat dibuat di Portal Pengaturan API
Referensi
Backup Get
Memeriksa kunci API dan mengembalikan perusahaan pemiliknya, beserta jenis catatan yang dapat Anda cadangkan dengan Backup Records Get.
Contoh Kueri
GET https://timeclock.kiwi/api/backup Contoh respons
|
|
|
|
|
|
|
|
|
Backup Records Get
Mengembalikan catatan Anda per halaman, dimulai dari perubahan terlama, sehingga Anda dapat menyimpan salinan sendiri.
Terus minta dengan next_cursor sampai has_more bernilai false, lalu simpan next_cursor terakhir. Lain kali, kirimkan untuk hanya mendapatkan yang berubah sejak saat itu. Cursor halaman terakhir mengulang perubahan dua jam sebelumnya, jadi perbarui catatan yang sudah Anda miliki alih-alih menambahkannya lagi.
Parameter
| Properti | Deskripsi | Jenis | Persyaratan | Default |
|---|---|---|---|---|
| entity | Jenis catatan yang dikembalikan: salah satu jenis catatan di bawah. Bagian dari path, misalnya /api/backup/shifts. | String | Wajib | |
| cursor | next_cursor dari halaman sebelumnya. Kosongkan untuk mulai dari awal. | String | Opsional | |
| limit | Berapa banyak catatan yang dikembalikan dalam satu halaman, dari 1 sampai 1000. | Integer | Opsional | 500 |
Jenis catatan
| Jenis catatan | Deskripsi |
|---|---|
| people | Semua orang di akun, termasuk orang yang telah dihapus. Masing-masing memiliki peran dan ID grupnya. |
| groups | Grup dan lokasi, beserta alamat, radius GPS, dan zona waktunya. |
| kiosks | Kios dan lokasi masing-masing. |
| jobs | Semua pekerjaan, termasuk yang sudah selesai dan dihapus. |
| tasks | Semua tugas. |
| shifts | Shift yang dikerjakan beserta waktu mulai dan selesai, total jam, jam kerja, dan jam istirahat, serta setiap kejadian dalam shift beserta pekerjaan, tugas, lokasi, dan posisi GPS-nya. |
| scheduled_shifts | Shift di jadwal yang diterbitkan. Shift yang sudah tidak ada di jadwal yang diterbitkan dikembalikan dengan on_published_roster bernilai false. |
| time_off | Permintaan cuti dan statusnya. |
| visits | Tamu yang melakukan registrasi masuk dan keluar di kios registrasi lokasi. |
Contoh Kueri
GET https://timeclock.kiwi/api/backup/shifts?limit=500&cursor=eyJ0IjoiMjAyNi0xMS0xMSAxNDo0MjowMi4xMjM0NTYiLCJpZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCIsInIiOjEyMH0 Contoh respons
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Groups Get
Mengembalikan informasi tentang objek grup. Akan mengembalikan semua grup.
Contoh Kueri
GET https://timeclock.kiwi/api/groups Contoh respons
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Jobs Get
Mengembalikan informasi tentang objek pekerjaan. Secara default akan mengembalikan semua pekerjaan.
Parameters
| Property | Description | Type | Requirement | Default |
|---|---|---|---|---|
| id | Memberikan ID akan mengembalikan pekerjaan tertentu. Jika nilai ini tidak diberikan, semua pekerjaan akan dikembalikan. | UUID | Optional | |
| completed | Hanya kembalikan pekerjaan yang kolom completed-nya cocok dengan nilai ini. | Boolean | Optional | false |
| deleted | Hanya kembalikan pekerjaan yang kolom deleted-nya cocok dengan nilai ini. | Boolean | Optional | false |
Example Query
GET https://timeclock.kiwi/api/jobs?id=01d2aa95-1866-4718-8d86-08aa5182f20d&completed=true&deleted=trueContoh respons
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Jobs Add
Menambahkan objek pekerjaan.
Body
| Property | Description | Type | Requirement | Default |
|---|---|---|---|---|
| name | Nama pekerjaan. | String | Required | |
| description | Deskripsi pekerjaan. | String | Optional | |
| permanent | Apakah pekerjaan ini dapat ditandai selesai? | Boolean | Optional | false |
| due_date | Tanggal tenggat penyelesaian pekerjaan. | String | Wajib jika permanent == false | |
| cost_code | Kode biaya untuk pekerjaan. | String | Optional | |
| completed | Apakah pekerjaan ini sudah selesai? | Boolean | Optional | false |
| deleted | Apakah pekerjaan ini sudah dihapus? | Boolean | Optional | false |
| budget_hours | Jam kerja yang dianggarkan (ditawarkan) untuk pekerjaan. null jika tanpa anggaran. | Number | Optional | null |
| priority | Apakah ini pekerjaan prioritas? Pekerjaan prioritas ditampilkan pertama di kios. | Boolean | Optional | false |
Example Query
POST https://timeclock.kiwi/api/jobs |
|
|
|
|
|
|
|
|
|
|
Contoh respons
|
|
|
|
|
|
|
|
|
|
|
|
Jobs Delete
Menghapus objek pekerjaan yang tercantum.
Body
| Properti | Deskripsi | Jenis | Persyaratan | Default |
|---|---|---|---|---|
| UUID | Daftar UUID semua pekerjaan yang akan dihapus. | UUID | Wajib |
Example Query
DELETE https://timeclock.kiwi/api/jobs |
Contoh respons
|
|
|
Jobs Update
Memperbarui objek pekerjaan.
Body
| Properti | Deskripsi | Jenis | Persyaratan | Default |
|---|---|---|---|---|
| id | UUID pekerjaan yang ingin Anda ubah. | UUID | Wajib | |
| name | Nama pekerjaan. | String | Wajib | |
| description | Deskripsi pekerjaan. | String | Opsional | |
| permanent | Apakah pekerjaan ini dapat ditandai selesai? | Boolean | Opsional | false |
| due_date | Tanggal tenggat penyelesaian pekerjaan. | String | Wajib jika permanent == false | |
| cost_code | Kode biaya untuk pekerjaan. | String | Opsional | |
| completed | Apakah pekerjaan ini sudah selesai? | Boolean | Opsional | false |
| deleted | Apakah pekerjaan ini sudah dihapus? | Boolean | Opsional | false |
| budget_hours | Jam kerja yang dianggarkan (ditawarkan) untuk pekerjaan. null jika tanpa anggaran. | Number | Opsional | null |
| priority | Apakah ini pekerjaan prioritas? Pekerjaan prioritas ditampilkan pertama di kios. | Boolean | Opsional | false |
| groups | UUID semua grup tempat pekerjaan ini berada. | UUID | Opsional | |
| people | UUID semua orang yang dapat melihat pekerjaan ini. | UUID | Opsional | |
| materials | Daftar semua material yang telah digunakan untuk pekerjaan ini. Material harus sudah digunakan oleh seseorang. | UUID | Opsional | |
| notes | Menambahkan catatan baru ke pekerjaan. | UUID | Opsional |
Example Query
PUT https://timeclock.kiwi/api/jobs |
|
|
|
|
|
|
|
|
|
|
|
|
|
Contoh respons
|
|
|
Kiosks Get
Mengembalikan informasi tentang objek kios. Akan mengembalikan semua kios.
Contoh Kueri
GET https://timeclock.kiwi/api/kiosks Contoh respons
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Materials Get
Mengembalikan informasi tentang objek material. Akan mengembalikan semua material.
Contoh Kueri
GET https://timeclock.kiwi/api/materials Contoh respons
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
People Get
Mengembalikan informasi tentang objek orang. Akan mengembalikan semua orang.
Contoh Kueri
GET https://timeclock.kiwi/api/people Contoh respons
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Shifts Get
Mengembalikan informasi tentang objek shift.
Parameter
| Properti | Deskripsi | Jenis | Persyaratan | Default |
|---|---|---|---|---|
| start-date | Hari pertama shift yang dikembalikan (inklusif). | Tanggal ISO 8601 (YYYY-MM-DD) | Wajib | |
| end-date | Hari terakhir shift yang dikembalikan (inklusif). | Tanggal ISO 8601 (YYYY-MM-DD) | Wajib | |
| group-id | Hanya kembalikan shift untuk orang yang termasuk dalam grup ini. | UUID | Opsional | |
| person-id | Hanya kembalikan shift untuk orang ini. | UUID | Opsional |
Example Query
GET https://timeclock.kiwi/api/shifts?start-date=2026-02-20&end-date=2026-02-27&group-id=752d68b5-5d57-4727-8c1c-85383b76fecf&person-id=a8b3e429-d307-4cd1-bde4-1c2510b6b8efContoh respons
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|