List workspaces
well_list_workspacesList the workspaces this connection is authorized to access.
Use this FIRST when a single token may cover more than one workspace. Each entry has:
workspace_id: pass this as the workspace_id argument on other tools to target one workspace.
workspace_name: human-readable name (null if it can't be resolved).
is_primary: true for the token's default workspace (used when you omit workspace_id on a write).
identity: the company behind the workspace (registered name, trade name, registry number, country, website, currency, fiscal year start), so two similarly-named workspaces can be told apart. Every field is null when the workspace has no accounting settings yet. Tax identifiers are deliberately not included.
has_bank_transactions: whether a connector the workspace BANKS with has delivered any transaction to it, meaning a bank, a neobank, or a treasury or spend platform whose product is an account. An accounting platform and a payment processor deliver transactions too and do NOT count here. Neither does a transaction whose source connector is unknown, whose install has since been disconnected, or whose catalog entry has been retired. Only
trueshows that a bank has fed this workspace:falsemeans no such transaction was found andnullmeans the signal could not be read, so an absent value is never a zero and neither value licenses skipping a bank-connection step. Read this before any month read when the flow needs to know whether the workspace banks with anything at all.
The result also carries session — what the user's card clicks have already recorded this session: pinned_workspace_id (null when not switched), workspace_queue (the workspaces to work through next, empty when none), selected_periods (the months picked on the period card, empty when none), and selected_counterparties (the counterparties picked on the missing-invoices card, with the workspace their company ids belong to; null when none was picked). Call this any time you need to resync with clicks you may have missed.
When the token authorizes a single workspace you can omit workspace_id everywhere; when it authorizes several, read tools fan out across all of them unless you pass a workspace_id, and write tools require one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspace_id | No | Target workspace. Optional: this tool describes the token itself rather than one workspace's data, so omitting it returns the same answer. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| session | No | What this session's card clicks recorded so far; null/empty fields when nothing was clicked yet. | |
| success | Yes | ||
| workspaces | Yes |