list_parties
List customers, vendors, or employees from your GnuCash books. Filter by active status, page with offset and limit, and choose compact text or full JSON.
Instructions
List customers, vendors, and/or employees.
Leads with a Showing X-Y of Z line per type, then a
compact one-line-per-party format by default. Page with
offset; limit=0 returns the count only. Use
verbose=true for full JSON with guid, address, notes, etc.
Args: party_type: "customer", "vendor", or "employee". Omit for all three (sections in that order). active_only: If True, only show active parties. Default True. verbose: If false (default), compact text output — optimized for reading and token efficiency. If true, structured JSON, for when you need machine-readable fields rather than a report. limit: Page size per type (default 50, max 250). 0 = count only. offset: 0-indexed first row to return (default 0).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| verbose | No | ||
| party_type | No | ||
| active_only | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |