List connector mappings
well_list_connector_mappingsList how one connected tool's data maps into Well: one row per Well record type (target_model, such as transactions or invoices) and provider tool (tool_name), with the JSONata expression that turns that tool's response into that record type and whether the mapping waits to be drawn again (needs_regeneration). A record type that several provider tools feed returns one row per tool.
Use it to answer "how does my Pennylane connection map its invoices?" or "why are this tool's invoices missing a field?". Pass the workspace_connector_id from well_list_connectors. Only a connection mapped by a drawn expression has mappings: an empty list means the connection is not mapped this way, never that it brings no data in. It reads the mappings and changes nothing: it starts no sync and draws no mapping. truncated says the list was cut at its bound.
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. | |
| workspace_connector_id | Yes | The workspace_connector_id of the connected tool, from well_list_connectors. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| success | Yes | ||
| mappings | No | ||
| truncated | 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. |