List clients
invoiceninja_list_clientsList clients with balances and contacts, optionally searched by name, email or number. Invoice Ninja: GET /api/v1/clients.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Only clients whose name matches. | |
| page | No | Page number, starting at 1. | |
| sort | No | Sort as "column|asc" or "column|desc", e.g. "number|desc" or "balance|desc". | |
| No | Only the client with a contact at this email. | ||
| filter | No | Free-text search across name, id number, contact names/emails/phones and custom fields. | |
| number | No | Only the client with this client number. | |
| status | No | Comma-separated record state: active, archived, deleted (e.g. "active"). Omit for all. | |
| balance | No | Balance comparison "op:value", op one of lt, lte, gt, gte, eq, e.g. "gt:0". | |
| per_page | No | Records per page, 1-100 (API default 20). |