List invite suggestions
well_list_invite_suggestionsList the teammates Well suggests inviting into this workspace: the people it found on the workspace owner's email domain who hold no membership, each as an open invite suggestion. Only a workspace owner or admin can read them; any other caller is refused with refusal_reason: "not_admin".
Use it for two things only. (1) Before you offer a teammate without being asked, at most once in a session opening: offer only when offer_allowed is true and suggestions is not empty, then record the offer with well_record_invite_answer (outcome: "offered") BEFORE you write the offer line, and write it only when that call returns recorded: true. (2) When the person answers an earlier offer ("later", "no"), to find the suggestion's task_id. To invite someone the person asked for, use well_list_member_candidates instead: a request is never limited by this cap.
Returns suggestions (every open suggestion, oldest first, at most the workspace's open cap; the order is not a preference, so pick from each row's last_offered_at; each with task_id, person_id, name, email, refusal_count and last_offered_at), offer_allowed (true when no unprompted offer went out in the last 7 days on any surface: web, extension, Claude, ChatGPT or WhatsApp) and next_offer_at. A suggestion the person put off or declined is not listed until it comes back 30 days later, and a second no removes it for good. On a demo workspace, which holds sample data, suggestions is empty, offer_allowed is false and refusal_reason is demo_workspace: offer nobody and say nothing about inviting: this read runs unprompted, so the person asked for nothing.
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 |
|---|---|---|---|
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| success | Yes | ||
| suggestions | Yes | ||
| workspace_id | No | ||
| next_offer_at | Yes | When the weekly offer cap frees, or null when it is free. | |
| offer_allowed | Yes | True when no unprompted invite offer went out in this workspace in the last 7 days, on any surface. | |
| refusal_reason | 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. |