read_survey
List or read surveys. Without survey_id, returns the cross-workspace catalog. With survey_id, returns survey detail — by default links only; pass include for collaborators, blocks, or flow_config. Workspaces that require two-factor authentication are readable only when the connector was approved with two-step verification; otherwise the catalog names any you belong to under hidden_workspaces.
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": "read_survey"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Catalog search — case-insensitive survey name or workspace label. Omit with survey_id to list every accessible survey. | |
| include | No | When survey_id is set, defaults to links only. Pass blocks, flow, or collaborators explicitly when needed. Ignored for catalog-only reads. | |
| survey_id | No | Survey UUID. When set, returns survey detail; omit for cross-workspace catalog. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |