Menu dokumentasi
Dokumentasi → API & Webhook → Pagination
Di halaman ini
KontrakContoh: iterasi semua addressEndpoint yang memakai pagination

Pagination

Endpoint list memakai cursor pagination (bukan offset). Ini stabil terhadap data baru dan konsisten di seluruh API.

Kontrak

Request:

ParamKeterangan
limitJumlah item per halaman, 1–100 (default 50). Di luar rentang di-clamp
cursorCursor dari halaman sebelumnya. Kosong = halaman pertama
Response menyertakan meta:
json
{
  "data": [ / ... / ],
  "meta": { "cursor": "MDFIWFku...", "hasMore": true }
}
  • meta.hasMore — true kalau masih ada halaman berikutnya.
  • meta.cursor — teruskan sebagai ?cursor= untuk mengambil halaman berikutnya. null kalau sudah di halaman terakhir.
Cursor bersifat opaque — jangan parse atau membuatnya sendiri; cukup teruskan apa adanya. Urutan hasil dari yang terbaru ke terlama (id menurun).

Contoh: iterasi semua address

bash
CURSOR=""
while : ; do
  RESP=$(curl -s -H "X-API-Key: clk_live_xxx" \
    "https://api.cloudin.id/v1/services/SVC_ID/addresses?limit=100&cursor=$CURSOR")

  echo "$RESP" | jq '.data[].fullAddress'


  HAS_MORE=$(echo "$RESP" | jq -r '.meta.hasMore')
  [ "$HAS_MORE" != "true" ] && break
  CURSOR=$(echo "$RESP" | jq -r '.meta.cursor')
done

Endpoint yang memakai pagination

  • GET /v1/services/:id/addresses
  • GET /v1/inboxes/:address/messages (juga mendukung q search)
  • GET /v1/webhooks/:id/deliveries (dashboard)
  • GET /v1/public/inbox/:address (white-label)
← Pesan (inbox)Error & rate limit →