GET
/
api
/
v1
/
workflows
{
  "results": [
    {
      "uid": "<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": {
            "uniqueIdentifier": "<string>",
            "autoUpgradeToLatestVersion": true,
            "version": 123
          },
          "input": {},
          "retryPolicy": {
            "maximumAttempts": 123,
            "initialInterval": 123,
            "backoffCoefficient": 123
          },
          "onFailure": "ABORT",
          "executionTimeout": 123,
          "isSleepActivity": true,
          "dependencies": [
            "<string>"
          ],
          "requireApproval": true,
          "approverType": "USER",
          "approver": "<string>",
          "approvalTimeout": 123,
          "filters": {},
          "compensationActivity": {
            "activity": {
              "uniqueIdentifier": "<string>",
              "autoUpgradeToLatestVersion": true,
              "version": 123
            },
            "input": {}
          }
        }
      ],
      "executingAgent": "<string>",
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "teamId": "<string>",
      "metadata": {}
    }
  ],
  "total": 123
}

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

Response

200
application/json
Operation successful
results
object[]
required
total
number
required