GET/v1/workflows

List workflows

Every automation workflow in this workspace with its trigger and its steps, newest first — the rules that fire on their own. It answers the workspace's OWN workflows only; for the vocabulary a workflow may be built FROM (the trigger kinds, step kinds, fields and operators) reach for get_workflows_catalog, which is the same for every workspace and is what a builder needs before anything has been created.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

bodyquery · nulloptional

paramsquery · objectoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": {
    "stepKinds": [
      "string"
    ],
    "triggerKinds": [
      "string"
    ],
    "workflows": [
      {
        "createdAt": "string",
        "createdByUserId": 1.5,
        "definition": {
          "steps": [
            {
              "action": "string",
              "id": "",
              "kind": "string",
              "preset": "string",
              "when": "string",
              "with": {
                "body": "string",
                "conversationId": "",
                "definition": "string",
                "notes": "string",
                "params": {
                  "key": "string",
                  "rowId": ""
                },
                "query": {
                  "accounts": "string",
                  "role": "string"
                },
                "row": "string",
                "status": "string",
                "subject": "string"
              }
            }
          ],
          "trigger": {
            "definitions": [
              "string"
            ],
            "event": "string",
            "kind": "string",
            "when": "string"
          }
        },
        "description": "string",
        "id": 1.5,
        "key": "string",
        "name": "string",
        "publishedAt": "string",
        "runAsAccountId": "",
        "status": "string",
        "updatedAt": "string",
        "version": 1.5
      }
    ]
  }
}

datarequired

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired

{ "data": { "stepKinds": [ "string" ], "triggerKinds": [ "string" ], "workflows": [ { "createdAt": "string", "createdByUserId": 1.5, "definition": { "steps": [ { "action": "string", "id": "", "kind": "string", "preset": "string", "when": "string", "with": { "body": "string", "conversationId": "", "definition": "string", "notes": "string", "params": { "key": "string", "rowId": "" }, "query": { "accounts": "string", "role": "string" }, "row": "string", "status": "string", "subject": "string" } } ], "trigger": { "definitions": [ "string" ], "event": "string", "kind": "string", "when": "string" } }, "description": "string", "id": 1.5, "key": "string", "name": "string", "publishedAt": "string", "runAsAccountId": "", "status": "string", "updatedAt": "string", "version": 1.5 } ] }}