List collection cases
LogsGET /cases
Returns a cursor-paginated list of the tenant's debt collection cases. Results can be narrowed by customer_id, account_id, status and aging_bucket, and search also matches accounts by holder name; page with limit (default 20, max 100) and the after cursor from the previous page. Requires collections:read.
Parameters
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Returns
200 Collection cases
Show attributes
dataShow child attributes
idtenant_idcustomer_idcustomer_nameDisplay name of the referenced customer. Omitted when unknown.
account_idaccount_numberNumber of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_nameDisplay name of the customer who holds the referenced account. Omitted when unknown.
total_debt_centscurrencyaging_bucketone of
current,30_days,60_days,90_days,120_days_plusstatusone of
open,notice_sent,payment_plan_active,enforcement_requested,resolved,written_offnotesThe case log rendered as text, one note per line. Kept for older clients and search; prefer note_entries.
note_entriesThe case log as entries, oldest first. A case written before entries existed has its whole notes text as one entry without a code.
Show child attributes
atactor_idcodeStable code of a note the server wrote (collection.case.opened_for_cutoff, collection.case.resolved, collection.case.enforcement_requested, collection.case.reopened_reversal); clients word it and fall back to text. Absent for notes people typed.
paramsValues the code's wording fills in: reason (resolved, enforcement_requested), payment (reopened_reversal).
textThe note as typed, or the server's wording of code.
dunning_leveldunning_statusone of
in_notice,cutoff_pending,disconnected,settledconnection_idconnection_holder_nameDisplay name of the customer who holds the referenced connection. Omitted when unknown.
cutoff_order_idreconnect_order_idcreated_atupdated_at
has_morenext_cursortotal_count
Permissions collections:read · Roles: admin, analyst, billing_clerk, customer_service, finance, owner, viewer
curl -X GET "$BUSINESS_API/cases" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/cases", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/cases",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/cases", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "col_2Zzko7TconRiwLFAepryspvaAXL",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
"customer_name": "Ana Matsinhe",
"account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"account_number": "ACC-2026-000142",
"account_holder_name": "Ana Matsinhe",
"total_debt_cents": 125000,
"currency": "MZN",
"aging_bucket": "current",
"status": "open",
"notes": "Leitura confirmada no local.",
"note_entries": [
{
"at": "2026-11-19T09:30:00Z",
"actor_id": "act_2HXCuXB4S938w5lomxpoS73e8fr",
"code": "COD-2026-000142",
"params": {
"key": "value"
},
"text": "text"
}
],
"dunning_level": 1,
"dunning_status": "in_notice",
"connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
"connection_holder_name": "Ana Matsinhe",
"cutoff_order_id": "cut_242PpqM5vCQBPkUpDe2pnkSb7MC",
"reconnect_order_id": "rec_2WinfG4fbWCx7oAXJyqJniKJdW2",
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor",
"total_count": 125000
}