list_clients
Paginated list of the clients the token's team does projects for, narrowed by status, search words or archived state.
Return the clients of the token's team, alphabetically, with how many projects each has; a guest sees only the clients of the projects they were invited into. Use it to find the client_id a project names, to pick a client before describing a new project, or to answer who the team works for and where each relationship stands.
Narrow with status (prospect, active, dormant, churned), search (words in the name, the legal name or the primary contact email) and archived (true for archived clients only, false for live ones; omit for both).
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
statusstringoptionalNarrow to one status.
prospectactivedormantchurnedsearchstringoptionalWords the name, legal name or primary contact email must contain.
archivedbooleanoptional`true` lists archived clients only, `false` live ones only; omit for both.
limitintegeroptionalClients per page (1..100, default 25).
1max100pageintegeroptional1-indexed page number.
1What it returns
{ "data": [ { "id": "c1a2b3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86", "name": "Acme Retail", "legal_name": "Acme Retail (Pvt) Ltd", "website": "https://acme.example", "industry": "Retail", "country": "LK", "timezone": "Asia/Colombo", "primary_contact_name": "Jane Perera", "primary_contact_email": "jane@acme.example", "notes": null, "status": "active", "projects_count": 2, "archived_at": null, "created_at": "2026-08-20T10:05:00+00:00", "updated_at": "2026-10-24T16:40:00+00:00" } ], "meta": { "page": 1, "limit": 25, "total": 1, "has_more": false }}How it fails
VALIDATION_FAILEDstatus is not one of the four statuses.
TOKEN_MISSING_ABILITYtoken lacks client:view-any.
How is this guide?
Last updated on