List customers
well_list_customersList the customers this workspace bills, and the companies it could define as a customer next. Draws the define-customer card.
Use it when an invoice needs a customer ("who is this invoice for", "bill Acme"). Pass query with the name, domain or registered name the user typed. Without query the read proposes the companies the workspace invoiced most recently.
Returns customers (companies already defined as customers) and candidates (companies that could be). Each row carries entity_kind ("company" or "person"), entity_id, name, provenance, confidence (the share of the workspace's newest issued invoices addressed to the company, null when it has none in that window), definable with definable_reason when it is false, invoices_issued, first_invoiced, people_count, identity (which carries address when the company has one) and other_workspaces (the member's other workspaces that already hold this same company, each with workspace_id, workspace_name and held_as — "customer" or "own_company"; empty when it is held nowhere else).
Pass include_external: true with a query when the graph holds no match: registry hits come back as candidates with provenance: "registry", and defining one adds the company to the workspace. Never pick a customer from a name alone; the user chooses on the card, then well_define_customer records the choice.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max rows per lane (default 25). | |
| query | No | What the user typed: a name, a registered name, a trade name or a domain. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. | |
| include_external | No | Also search the public company registries. Needs a query of at least 2 characters. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| success | Yes | ||
| customers | Yes | ||
| candidates | Yes | ||
| error_reason | No | ||
| own_company_id | No | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |