Skip to main content
GET
/
orchestration
/
workflows
/
list
List workflows
curl --request GET \
  --url https://api.getcargo.io/v1/orchestration/workflows/list \
  --header 'Authorization: Bearer <token>'
{
  "workflows": [
    {
      "uuid": "<string>",
      "workspaceUuid": "<string>",
      "nodes": [
        {
          "uuid": "<string>",
          "slug": "<string>",
          "nodes": "<array>",
          "isArchived": true,
          "kind": "<string>",
          "actionSlug": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "playUuid": "<string>",
      "toolUuid": "<string>",
      "folderUuid": "<string>",
      "lastBatch": {
        "uuid": "<string>",
        "status": "pending",
        "runsStatus": "healthy",
        "errorMessage": "<string>",
        "createdAt": "<string>",
        "finishedAt": "<string>"
      },
      "deployedRelease": {
        "uuid": "<string>",
        "userUuid": "<string>",
        "description": "<string>",
        "version": "<string>",
        "nodes": [
          {
            "uuid": "<string>",
            "slug": "<string>",
            "config": {},
            "childrenUuids": [
              "<string>"
            ],
            "fallbackOnFailure": true,
            "position": {
              "x": 123,
              "y": 123
            },
            "kind": "native",
            "actionSlug": "<string>",
            "name": "<string>",
            "description": "<string>",
            "retry": {
              "maximumAttempts": 123,
              "initialInterval": 123,
              "backoffCoefficient": 123
            },
            "fallbackChildUuid": "<string>"
          }
        ],
        "formFields": [
          {
            "slug": "<string>",
            "name": "<string>",
            "kind": "string",
            "description": "<string>",
            "isRequired": true
          }
        ],
        "templateSlug": "<string>",
        "deployedAt": "<string>",
        "createdAt": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful response

Response body schema.

workflows
Workflows · object[]
required

List of workflows.