v1

latestOpenAPI 3.0.12026-07-265879107.5 KB

Workflows

List playbooks with optional filtering

Retrieve a paginated list of playbooks from the specified workspace. Supports RQL-based filtering.

get/workspace/{ws_id}/playbooks

Path parameters

ws_idstring required

Workspace ID

Query parameters

qstring

The RQL query object to filter playbooks by. For more information, see our RQL documentation

Response

Paginated list of matching playbooks

limitinteger

offsetinteger

totalinteger

Example response

{
  "results": [
    {
      "display_settings": {
        "description": "Automates common tasks",
        "icon": "company-blink",
        "name": "Blink Automation"
      },
      "icon": "company-blink",
      "name": "My Workflow",
      "pack_id": "00000000-0000-0000-0000-000000000000",
      "tags": [
        "k8s"
      ],
      "version": "1"
    }
  ]
}