invoiceninja_list_clients
Retrieve and filter clients from Invoice Ninja with sorting, pagination, and advanced filters like balance, tags, dates, and status.
Instructions
List clients from Invoice Ninja with filtering, sorting and pagination. extra_filters keys: name, email, number, id_number, vat_number, balance ('gt:0', 'lt:100', operators lt/lte/gt/gte/eq), between_balance ('10:100'), group (group settings id), country_id, classification; created_between / updated_between ('YYYY-MM-DD,YYYY-MM-DD'), tag_ids (comma separated), assigned_user_ids. Use invoiceninja_get_client with an id from this list for the full record.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1 | |
| sort | No | Sort as 'column|asc' or 'column|desc', e.g. 'date|desc' | |
| fields | No | JSON format only: return just these top-level fields (id is always included), e.g. ['number', 'client_name', 'balance', 'due_date'] | |
| filter | No | Free-text search across the main columns (number, name, contacts, notes…) | |
| status | No | Lifecycle filter, comma separated: active, archived, deleted (e.g. 'active' to skip archived and deleted records) | |
| include | No | Extra relations to embed, comma separated (e.g. 'payments,activities') | |
| per_page | No | Records per page (1-100) | |
| extra_filters | No | Additional API query filters as name -> value (see the tool description) | |
| response_format | No | 'markdown' (default) for a readable summary, 'json' for complete machine-readable data (empty fields removed) | markdown |