Get workflows

Base URL: https://{kibana_url}

GET /api/workflows

Auth

Retrieve a paginated list of workflows with optional filtering.

Required authorization

Privileges workflowsManagement:read. Extended privileges (optional, expand functionality when granted): workflowsManagement:managed:read, workflowsManagement:readExecution, workflowsManagement:managed:readExecution

Query parameters

query string: Free-text search query.
size number · min: 1: Number of results per page.
page number · min: 1: Page number.
enabled boolean[] · max items: 2: Filter by enabled state.
createdBy string[] · max items: 1000: Filter by creator.
tags string[] · max items: 1000: Filter by tags.
managed enum: Filter by managed status. Defaults to "unmanaged".; Values: all managed unmanaged
visibilityContext string[] · max items: 1000: When managed workflows are included, only return managed workflows visible in these contexts.
sortField enum: Field to sort by.; Values: name enabled
sortOrder enum: Sort direction.; Values: asc desc

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn://api/workflows?size=20&page=1&sortField=name&sortOrder=asc

curl Shell

curl \
  -X GET "${KIBANA_URL}/api/workflows?size=20&page=1&sortField=name&sortOrder=asc" \
  -H "Authorization: ApiKey ${API_KEY}"

Response

Example response returning a paginated list of workflows

{
  "page": 1,
  "results": [
    {
      "createdAt": "2025-11-20T10:30:00.000Z",
      "definition": {
        "description": "This is a workflow example",
        "enabled": true,
        "inputs": [
          {
            "default": "hello world",
            "name": "message",
            "type": "string"
          }
        ],
        "name": "Example definition",
        "steps": [
          {
            "name": "hello_world_step",
            "type": "console",
            "with": {
              "message": "{{ inputs.message }}"
            }
          }
        ],
        "triggers": [
          {
            "type": "manual"
          }
        ]
      },
      "description": "This is a workflow example",
      "enabled": true,
      "history": [
        {
          "duration": 5000,
          "finishedAt": "2025-11-20T12:00:05.000Z",
          "id": "exec-001",
          "startedAt": "2025-11-20T12:00:00.000Z",
          "status": "completed",
          "workflowId": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "workflowName": "Example definition"
        }
      ],
      "id": "workflow-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Example definition",
      "tags": [
        "example"
      ],
      "valid": true
    }
  ],
  "size": 20,
  "total": 1
}