List workflows | Taurus Developer Hub

{
  "result": [
    {
      "id": "string",
      "tenantID": "string",
      "status": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "scheduledFor": "2024-01-15T09:30:00Z",
      "reservedBy": "string",
      "reservedUntil": "2024-01-15T09:30:00Z",
      "trails": [
        {
          "id": "string",
          "tenantID": "string",
          "workflowID": "string",
          "eventID": "string",
          "workflowAction": "string",
          "emittedEventsIDs": [
            "string"
          ],
          "createdWorkflowsIDs": [
            "string"
          ],
          "workflowActionResult": {
            "type": "success",
            "errorResult": {
              "message": "string",
              "errorCode": "string",
              "errorID": "string"
            }
          },
          "workflowStateLabelBefore": "string",
          "workflowStateLabelAfter": "string",
          "createdAt": "2024-01-15T09:30:00Z"
        }
      ],
      "workflowType": "string",
      "workflowPayload": "string",
      "state": "string"
    }
  ],
  "cursor": {
    "currentPage": "string",
    "hasPrevious": true,
    "hasNext": true
  }
}

This endpoint returns a list of workflows

Authentication

AuthorizationBearer

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

Query parameters

cursor.currentPagestringOptional

Base64-encoded string representing the current window of data

cursor.pageRequeststringOptional

The page to request, w.r.t the current page. Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSizestringOptionalformat: "uint64"

The size of the page requested. The handling service should impose a hard limit on this

ids.idslist of stringsOptional

Filter for specific workflows, identified by their UUIDs

status.statusstringOptional

Filter on workflow status, can be 'active' or 'completed'

workflowType.workflowTypestringOptional

Filter for specific workflow types

workflowTypeAndStates.workflowTypestringOptional

Filter for specific workflow types

workflowTypeAndStates.stateslist of stringsOptional

Filters workflows by state, applicable only when a specific workflow type is set

Response

A successful response.

resultlist of objectsOptional

cursorobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error