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

Request

  • Base URL
    https://your-tenant.app.blinkops.com/api/v1
  • URL
    https://your-tenant.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks
  • Auth
    API key in header BLINK-API-KEY

Path parameters

ws_idstring required

Workspace ID

Query parameters

qstring

Optional. An RQL query, passed as a JSON object, to filter, sort, select fields, and page through results. See RQL. Example: {"limit":10,"offset":0}

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"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.