List expected household papers
well_list_expected_documentsList the papers Well filed from the person's mail in their personal space this month, and each regular sender whose monthly paper is expected, with its state this month. Use it for "retrouve mes papiers du mois", "which bills have not arrived this month" or "is my energy bill late" in a personal space. It reads stored documents only: it reads no mailbox, no bank payment and no supplier site.
filed_this_month: count is every paper that came by mail in current_month (UTC); papers lists the newest 20 at most, each with document_id, filename, received_at and sender_name (the issuer Well read on it, or null). truncated: true means the count holds more papers than the list.
regular_senders: the senders that sent a paper by mail in each of the 3 months of prior_months. Each has company_id, name, months_received, latest_usual_day (the latest day of month a paper came in those months) and state:
"arrived": this month's paper came."late": no paper this month and today is pastlatest_usual_day. It has not arrived yet: it may still come, or come by post. Never call it missing."not_due_yet": no paper this month and today is not pastlatest_usual_day. Never name it as late. A sender absent from the list sends on no regular monthly rhythm: never name it as expected.senders_truncated: truemeans the sender history hit its cap, so a regular sender may be missing from the list.
not_applicable: "not_personal_space" means the workspace is not the person's own space: its papers are company receipts, so no household papers answer exists for it.
An empty filed_this_month with no regular_senders means Well filed no paper from the mail in the window, not that the mailbox is connected and empty: check the mailbox connection before saying so.
status: "failed" means the read failed: the papers and the senders are unknown, never empty.
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 | ||
| status | Yes | ||
| success | Yes | ||
| prior_months | No | ||
| current_month | No | ||
| not_applicable | 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. | |
| regular_senders | No | ||
| filed_this_month | No | ||
| senders_truncated | No | ||
| 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. |