list_clients
Retrieve client records from FreshBooks with optional search by name or organization. Filter and paginate results to manage customer information efficiently.
Instructions
List clients. Optional search by name or organization.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| per_page | No | ||
| search | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- src/mcp_freshbooks/server.py:206-216 (handler)The `list_clients` function is defined as an MCP tool handler in `src/mcp_freshbooks/server.py`. It fetches client information using the `client.accounting_list` method and formats the results.
async def list_clients( page: int = 1, per_page: int = 25, search: str | None = None, ) -> str: """List clients. Optional search by name or organization.""" filters = {} if search: filters["organization_like"] = search result = await client.accounting_list("users/clients", page, per_page, filters) return _summarize_list(result, "clients", ["id", "fname", "lname", "organization", "email"])