LLM-readable documentation index
Open Dashboard
Workflows
DocumentationAPI Reference

List Workflows

Hand off to an LLM

List workflows in the current environment.

Returns each workflow's current version, including its node graph and main node. Combine filters freely — they AND together.

Filtering

  • workflowIDs / workflowNames: exact-match identity filters.
  • displayName: case-insensitive substring match.
  • tags: returns workflows tagged with any of the supplied tags.
  • functionIDs / functionNames: returns only workflows that reference the named functions in any node. Useful for "which workflows depend on this function?" lookups before changing or deleting a function.
  • functionIDVersionNums / functionNameVersionNums: the same lookup narrowed to nodes pinned to a specific function version.

Pagination

Cursor-based with startingAfter and endingBefore (workflowIDs). Default limit 50, maximum 100.

GET
/v3/workflows

Authorization

API Key
x-api-key<token>

Authenticate using API Key in request header

In: header

Query Parameters

limit?integer
Default50
Range1 <= value <= 100
workflowIDs?array<>
Items1 <= items
workflowNames?array<>
Items1 <= items
displayName?string
sortOrder?string
Default"asc"
Value in"asc" | "desc"
startingAfter?string
endingBefore?string
tags?array<>
Items1 <= items
functionIDs?array<>
Items1 <= items
functionNames?array<>
Items1 <= items
functionIDVersionNums?array<>

Return only workflows with a node pinned to a specific function version. Each entry is <functionID>.<versionNum> — for example fn_2c9AXIj48cUYJtCuv1gsQtHGDzK.4.

Items1 <= items
functionNameVersionNums?array<>

Return only workflows with a node pinned to a specific function version, keyed by function name. Each entry is <functionName>.<versionNum> — for example invoice-extract.4.

Items1 <= items

Response Body

application/json

curl -X GET "https://api.bem.ai/v3/workflows"
{
  "workflows": [
    {
      "id": "string",
      "name": "string",
      "versionNum": 0,
      "displayName": "string",
      "emailAddress": "string",
      "tags": [
        "string"
      ],
      "mainNodeName": "string",
      "nodes": [
        {
          "name": "string",
          "function": {
            "id": "string",
            "name": "string",
            "versionNum": 0
          },
          "metadata": {}
        }
      ],
      "edges": [
        {
          "sourceNodeName": "string",
          "destinationName": "string",
          "destinationNodeName": "string",
          "metadata": {}
        }
      ],
      "connectors": [
        {
          "connectorID": "string",
          "name": "string",
          "type": "paragon",
          "paragon": {
            "integration": "string",
            "configuration": {},
            "syncID": "string"
          }
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "audit": {
        "workflowCreatedBy": {
          "userActionID": "string",
          "userID": "string",
          "userEmail": "string",
          "apiKeyName": "string",
          "emailAddress": "string",
          "createdAt": "2019-08-24T14:15:22Z"
        },
        "workflowLastUpdatedBy": {
          "userActionID": "string",
          "userID": "string",
          "userEmail": "string",
          "apiKeyName": "string",
          "emailAddress": "string",
          "createdAt": "2019-08-24T14:15:22Z"
        },
        "versionCreatedBy": {
          "userActionID": "string",
          "userID": "string",
          "userEmail": "string",
          "apiKeyName": "string",
          "emailAddress": "string",
          "createdAt": "2019-08-24T14:15:22Z"
        }
      },
      "restricted": true
    }
  ],
  "totalCount": 0,
  "error": "string"
}

See also

List Workflow Versions GET

Previous Page

Update a Workflow PATCH

Next Page