List customers
Authentication
A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.
Query parameters
Matches a customer’s name, email address or external_id, for search boxes. Part of a word matches.
A decimal amount. Only customers whose available balance in credit_type is below it.
The credit type (ID or key) that has_balance_below applies to.
The next_cursor from the previous page.
Send total_count to add total_count to the list: how many objects match the filters across every page. The count is capped, and total_count_approximate: true says when the real number is higher. It is slower than a plain list, so ask for it when you show a number.
Response
Only with include=total_count. How many objects match the filters.
Only with include=total_count. True when the count was capped and the real number is higher.