List my workspaces
list_my_workspacesThe workspaces this connection can act in, each with its name, your role there and its id. For a person signed in it is usually the first call before forms are read or changed: with one workspace, that one is used; with several, the user chooses one by name, and its id goes as workspace_id on every call. Staff of this deployment can act in any workspace: search finds a customer's, and the exact workspace is confirmed with the user before use, even when only one matches. With an API key it lists the key's own workspace, the only one the key can act in.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_my_workspaces"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | At most this many workspaces (default: every one that applies; a staff search returns at most 20). | |
| search | No | Only workspaces whose name contains this text. Staff of this deployment: searches every workspace (by workspace or account name, and by a member's email or a form name where dForms knows it); needs at least 3 letters or digits and returns at most 20. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| staff | Yes | True when you are staff of this deployment and can act in any workspace. | |
| next_step | Yes | The suggested next step with these workspaces. | |
| truncated | Yes | True when more workspaces apply than were returned (the limit, or the staff search cap): refine the search, or raise limit. | |
| workspaces | Yes |