GET
/
api
/
v1
/
workflows
Get all the workflows defined by the organization
curl --request GET \
  --url https://workflow-app.thena.ai/api/v1/workflows \
  --header 'x-api-key: <api-key>'
{
  "results": [
    {
      "uid": "<string>",
      "type": "<string>",
      "subType": "<string>",
      "uniqueIdentifier": "<string>",
      "name": "<string>",
      "version": 123,
      "triggerEvent": {
        "uid": "<string>",
        "description": "<string>",
        "eventName": "<string>",
        "source": "platform_app",
        "schema": {},
        "metadata": {}
      },
      "filters": {},
      "annotations": [
        "<string>"
      ],
      "workflowDefinition": [
        {
          "stepIdentifier": 123,
          "activity": {
            "name": "<string>",
            "uniqueIdentifier": "<string>",
            "version": 123,
            "autoUpgradeToLatestVersion": true
          },
          "input": {},
          "retryPolicy": {
            "maximumAttempts": 123,
            "initialInterval": 123,
            "backoffCoefficient": 123
          },
          "onFailure": "<string>",
          "isSleepActivity": true,
          "executionTimeout": 123,
          "approver": {
            "type": "TEAM",
            "uid": "<string>",
            "timeout": 123
          },
          "dependencies": [
            "<string>"
          ],
          "filters": {},
          "compensationActivity": {}
        }
      ],
      "executingAgent": "<string>",
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "teamId": "<string>",
      "metadata": {}
    }
  ],
  "total": 123
}

Authorizations

x-api-key
string
header
required

Enter your API key

Query Parameters

teamId
string

The team id to fetch workflows by

page
number

The page number to fetch workflows by

limit
number

The limit of workflows to fetch

type
string

The type of workflows to fetch

subTypes
string

Comma separated sub types of workflows to fetch

Example:

"WORKFLOW,AI_AGENT"

Response

200
application/json

Operation successful

The response is of type object.