List Runbooks
list_runbooksLists all runbooks in a specified workspace, with filters for archived status, folder, template status, and source template, so you can find the exact runbooks you need.
Instructions
List all runbooks in a specific workspace.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"workspace_id": "<workspace_id>"
},
"name": "list_runbooks"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| archived | No | Filter by archived status. Pass false to exclude archived runbooks, true to show only archived. | |
| folder_id | No | Filter to only runbooks in this folder ID. | |
| is_template | No | Filter by template status. Pass false to exclude templates, true to show only templates. | |
| extra_params | No | Additional query parameters to pass to the API (e.g. {"stage": "active"}). | |
| workspace_id | Yes | The unique identifier for the workspace. | |
| source_runbook_id | No | Filter to only runbooks created from this template ID. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| meta | Yes | Top-level metadata for a list response. | |
| links | Yes | Pagination links for a list response. | |
| included | No |