Daftar event

GET/v1/eventsJalankan

Membutuhkan izin webhooks:read.

Parameter query

typestringopsional

Satu jenis event, atau keluarga seperti payment.*.

Contoh: payment.succeeded

Pola: ^(\*|[a-z_]+(\.[a-z_]+)*(\.\*)?)$

Panjang maksimum: 64

project_idstringopsional

Hanya event proyek ini.

Contoh: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali prj_.

payment_idstringopsional

Hanya event tentang pembayaran ini.

Contoh: pay_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali pay_.

payment_link_idstringopsional

Hanya event tentang payment link ini.

Contoh: lnk_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali lnk_.

starting_afterstringopsional

Id item terakhir di halaman yang sudah kamu punya. Halaman berikutnya dimulai setelah item itu.

Contoh: wev_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali wev_.

limitintegeropsional

Jumlah item per halaman, dari 1 sampai 100. Bawaannya 20.

Contoh: 20

Minimum: 1

Maksimum: 100

Respons (200)

Mengembalikan satu halaman daftar: data berisi item, dan meta.pagination menunjukkan kelanjutannya. Halaman berikutnya dengan limit dan starting_after (id item terakhir yang sudah kamu punya), atau ambil meta.pagination.next.

dataarray dari objectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

metaobjectwajib

Detail request seperti id dan kursor paginasi.

request_idstringwajib

Id request ini. Sebutkan saat bertanya ke dukungan.

Contoh: req_Hy3k9QzT2LmN8vXa

paginationobjectwajib

Detail paginasi untuk respons daftar. Gunakan next untuk mengambil halaman berikutnya, atau starting_after untuk menyusun URL sendiri.

per_pageintegerwajib

Jumlah item yang dikembalikan di halaman ini.

Contoh: 20

has_morebooleanwajib

true berarti masih ada item di halaman berikutnya.

nextstring | nullwajib

Alamat halaman berikutnya, dengan filtermu tetap; null di halaman terakhir.

Contoh: string

Request yang gagal dijawab dengan bentuk error yang sama; lihat Error.

Request

curl "https://api.baiyar.com/v1/events" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Respons

{
  "data": [
    {}
  ],
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa",
    "pagination": {
      "per_page": 20,
      "has_more": true,
      "next": "https://api.baiyar.com/v1/events?starting_after=id"
    }
  }
}