List Workflows

Returns workflows owned by the caller (matched on api_key) unioned with any workflows shared with them via the sharing service. If the sharing service is unavailable, the response degrades to owner-only results.

GET /workflows

List workflows

cURL

curl --request GET \
  --url https://inference.studio.lyzr.ai/api/workflows \
  --header 'x-api-key: <api-key>'

200

[
  {
    "flow_id": "<string>",
    "flow_name": "Document Processing Flow",
    "flow_data": {
      "name": "Minimal Example",
      "nodes": [
        {
          "id": "a1b2c3d4-0000-0000-0000-000000000001",
          "name": "Trigger",
          "type": "lyzr-nodes-base.trigger",
          "typeVersion": 1,
          "parameters": {},
          "position": [
            240,
            300
          ]
        },
        {
          "id": "a1b2c3d4-0000-0000-0000-000000000002",
          "name": "Set",
          "type": "lyzr-nodes-base.set",
          "typeVersion": 3.4,
          "parameters": {
            "assignments": {
              "assignments": [
                {
                  "id": "f1",
                  "name": "greeting",
                  "type": "string",
                  "value": "=Hello {{ $json.name }}"
                }
              ]
            }
          },
          "position": [
            480,
            300
          ]
        }
      ],
      "connections": {
        "Trigger": {
          "main": [
            [
              {
                "node": "Set",
                "type": "main",
                "index": 0
              }
            ]
          ]
        }
      },
      "settings": {}
    },
    "version": 123,
    "is_owner": true,
    "live_version_id": "<string>",
    "has_unpublished_changes": true,
    "is_locked": true,
    "user_id": "<string>",
    "org_id": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
]

Authorizations

x-api-key · string · header · required

Lyzr API key. Studio session keys (agk_, ags_) and durable sk- keys are accepted. Required on every endpoint except GET /node-types and a webhook-triggered execute that carries X-Webhook-Secret.

Response

200

application/json

OK

flow_id · string

flow_name · string

Example:

"Document Processing Flow"

flow_data · object

Workflow graph definition as JSON (nodes, connections, and node configuration). See the flow_data reference for the full structure and the node types reference for every node type.

Example:

{
  "name": "Minimal Example",
  "nodes": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Trigger",
      "type": "lyzr-nodes-base.trigger",
      "typeVersion": 1,
      "parameters": {},
      "position": [240, 300]
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000002",
      "name": "Set",
      "type": "lyzr-nodes-base.set",
      "typeVersion": 3.4,
      "parameters": {
        "assignments": {
          "assignments": [
            {
              "id": "f1",
              "name": "greeting",
              "type": "string",
              "value": "=Hello {{ $json.name }}"
            }
          ]
        }
      },
      "position": [480, 300]
    }
  ],
  "connections": {
    "Trigger": {
      "main": [
        [
          { "node": "Set", "type": "main", "index": 0 }
        ]
      ]
    }
  },
  "settings": {}
}

version · integer

is_owner · boolean

Computed per response so the UI can distinguish owned rows from shared rows without seeing the owner's key. Not persisted.

live_version_id · string · read-only

The version production runs. Absent until a version has been deployed, in which case production runs the draft.

has_unpublished_changes · boolean · read-only

True when the draft differs from the newest version, or when nothing has been published yet.

is_locked · boolean · read-only

True when the owner has locked the workflow. Set it with PATCH /workflows/{id}/lock; a normal save never changes it.

user_id · string

org_id · string

created_at · string

updated_at · string