List workflow runs - Upstash Documentation

GET

workflows

logs

curl https://qstash.upstash.io/v2/workflows/logs \
  -H "Authorization: Bearer <token>"

{
  "cursor": "1686652644442-12",
  "runs": [
    {
      "workflowRunId": "wfr_rj0Upr1rvdzGfz96fXNHh",
      "workflowUrl": "https://feasible-eft-notably.ngrok-free.app/api/call",
      "workflowState": "RUN_SUCCESS",
      "workflowRunCreatedAt": 1736340463061,
      "workflowRunCompletedAt": 1736340464684,
      "steps": [
        {
          "steps": [
            {
              "stepName": "init",
              "stepType": "Initial",
              "callType": "step",
              "messageId": "msg_7YoJxFpwkEy5zBp378JgvD6YBDPBEqkBPje2JGTCEUiASMJQ1FwY9",
              "concurrent": 1,
              "state": "STEP_SUCCESS",
              "createdAt": 1736340463064
            }
          ],
          "type": "sequential"
        },
        {
          "steps": [
            {
              "stepId": 1,
              "stepName": "external call",
              "stepType": "Run",
              "callType": "step",
              "messageId": "msg_26hZCxZCuWyyTWPmSVBrNCtiJGNsULmt63vFfcZxQ3sfYFKLZe2dKww4BSb2kVF",
              "out": "1",
              "concurrent": 2,
              "state": "STEP_SUCCESS",
              "createdAt": 1736340464111
            },
            {
              "stepId": 2,
              "stepName": "external call 2",
              "stepType": "Run",
              "callType": "step",
              "messageId": "msg_26hZCxZCuWyyTWPmSVBrNB882AMRP1TsgzpygELRcLWep4ACNTTsCHhrZuaNLij",
              "out": "2",
              "concurrent": 2,
              "state": "STEP_SUCCESS",
              "createdAt": 1736340463895
            }
          ],
          "type": "parallel"
        }
      ]
    }
  ]
}

You can fetch details about workflow runs, including their state, completed and in-progress steps, and step details.

The retention duration for completed workflow runs depends on your quota. Please check the pricing page for details.

If you have executed multiple workflow runs with the same workflowRunId, the workflowRunId filter will return all of them.

To uniquely identify a single workflow run, include the workflowCreatedAt timestamp in your filter.

Request

cursor

string

By providing a cursor you can paginate through all of the workflow runs.

workflowRunId

string

Filter workflow runs by run id.

workflowUrl

string

Filter workflow runs by workflow url.

workflowCreatedAt

number

Filter workflow runs by the unix milliseconds value of creation timestamp

state

string

Filter workflow runs by state

Value	Description
`RUN_STARTED`	The workflow has started to run and currently in progress.
`RUN_SUCCESS`	The workflow run has completed succesfully.
`RUN_FAILED`	Some errors has occured and workflow failed after all retries.
`RUN_CANCELED`	The workflow run has canceled upon user request.

fromDate

number

Filter workflow runs by starting date, in milliseconds (Unix timestamp). This is inclusive.

toDate

number

Filter workflow runs by ending date, in milliseconds (Unix timestamp). This is inclusive.

count

number

The number of workflow runs to return. Default and max is 10.

Response

cursor

string

A cursor which you can use in subsequent requests to paginate through all workflow runs. If no cursor is returned, you have reached the end of the workflow runs.

runs

Array

workflowRunId

string

The ID of the workflow run.

workflowUrl

string

The URL address of the workflow server.

workflowState

string

The current state of the workflow run at this point in time

Value	Description
`RUN_STARTED`	The workflow has started to run and currently in progress.
`RUN_SUCCESS`	The workflow run has completed succesfully.
`RUN_FAILED`	Some errors has occured and workflow failed after all retries.
`RUN_CANCELED`	The workflow run has canceled upon user request.

workflowCreatedAt

number

The Unix timestamp (in milliseconds) when the workflow run started.

workflowRunCompletedAt

string

The Unix timestamp (in milliseconds) when the workflow run was completed, if applicable.

failureFunction

FailureFunction

The details of the failure callback message, if a failure function was defined for the workflow.

steps

Array

type

string

The type of grouped steps

Value	Description
`sequential`	Indicates only one step is excuted sequentially
`parallel`	Indicates multiple steps being executed in parallel.
`next`	Indicates there is information about currently executing step(s)

steps

Array

stepId

number

The ID of the step which increases monotonically.

stepName

string

The name of the step. It is specified in workflow by user.

stepType

string

Execution type of the step which indicates type of the context function.

Value	Function
`Initial`	The default step which created automatically
`Run`	context.run()
`Call`	context.call()
`SleepFor`	context.sleepFor()
`SleepUntil`	context.sleepUntil()
`Wait`	context.waitForEvent()
`Notify`	context.notify()
`Invoke`	context.invoke()

messageId

string

The ID of the message associated with this step.

out

string

The output returned by the step

concurrent

string

The total number of concurrent steps that is running alongside this step

state

string

The state of this step at this point in time

Value	Description
`STEP_SUCCESS`	Indicates only one step is excuted sequentially
`STEP_RETRY`	Indicates multiple steps being executed in parallel.
`STEP_FAILED`	Indicates there is information about currently executing step(s)
`STEP_CANCELED`	Indicates there is information about currently executing step(s)

createdAt

string

The unix timestamp in milliseconds when the message associated with this step has created.

The following fields are set only when a specific type of step is executing. These fields are not available for all step types.

sleepFor

string

The duration in milliseconds which step will sleep. Only set if stepType is SleepFor.

sleepUntil

string

The unix timestamp (in milliseconds) which step will sleep until. Only set if stepType is SleepUntil.

waitEventId

string

The event id of the wait step. Only set if stepType is Wait.

waitTimeoutDeadline

string

The unix timestamp (in milliseconds) when the wait will time out.

waitTimeoutDuration

string

The duration of timeout in human readable format (e.g. 120s, 1m, 1h).

waitTimeout

string

Set to true if this step is cause of a wait timeout rather than notifying the waiter.

callUrl

string

The URL of the external address. Available only if stepType is Call.

callMethod

string

The HTTP method of the request sent to the external address. Available only if stepType is Call.

callHeaders

string

The HTTP headers of the request sent to the external address. Available only if stepType is Call.

callBody

string

The body of the request sent to the external address. Available only if stepType is Call.

callResponseStatus

number

The HTTP status returned by the external call. Available only if stepType is Call.

callResponseBody

string

The body returned by the external call. Available only if stepType is Call.

callResponseHeaders

array

The HTTP headers returned by the external call. Available only if stepType is Call.

invokedWorkflowRunId

string

The ID of the invoked workflow run if this step is an invoke step.

invokedWorkflowUrl

string

The URL address of the workflow server of invoked workflow run if this step is an invoke step.

invokedWorkflowCreatedAt

number

The Unix timestamp (in milliseconds) when the invoked workflow was started if this step is an invoke step.

invokedWorkflowRunBody

string

The body passed to the invoked workflow if this step is an invoke step.

invokedWorkflowRunHeaders

string

The HTTP headers passed to invoked workflow if this step is an invoke step.

curl https://qstash.upstash.io/v2/workflows/logs \
  -H "Authorization: Bearer <token>"

{
  "cursor": "1686652644442-12",
  "runs": [
    {
      "workflowRunId": "wfr_rj0Upr1rvdzGfz96fXNHh",
      "workflowUrl": "https://feasible-eft-notably.ngrok-free.app/api/call",
      "workflowState": "RUN_SUCCESS",
      "workflowRunCreatedAt": 1736340463061,
      "workflowRunCompletedAt": 1736340464684,
      "steps": [
        {
          "steps": [
            {
              "stepName": "init",
              "stepType": "Initial",
              "callType": "step",
              "messageId": "msg_7YoJxFpwkEy5zBp378JgvD6YBDPBEqkBPje2JGTCEUiASMJQ1FwY9",
              "concurrent": 1,
              "state": "STEP_SUCCESS",
              "createdAt": 1736340463064
            }
          ],
          "type": "sequential"
        },
        {
          "steps": [
            {
              "stepId": 1,
              "stepName": "external call",
              "stepType": "Run",
              "callType": "step",
              "messageId": "msg_26hZCxZCuWyyTWPmSVBrNCtiJGNsULmt63vFfcZxQ3sfYFKLZe2dKww4BSb2kVF",
              "out": "1",
              "concurrent": 2,
              "state": "STEP_SUCCESS",
              "createdAt": 1736340464111
            },
            {
              "stepId": 2,
              "stepName": "external call 2",
              "stepType": "Run",
              "callType": "step",
              "messageId": "msg_26hZCxZCuWyyTWPmSVBrNB882AMRP1TsgzpygELRcLWep4ACNTTsCHhrZuaNLij",
              "out": "2",
              "concurrent": 2,
              "state": "STEP_SUCCESS",
              "createdAt": 1736340463895
            }
          ],
          "type": "parallel"
        }
      ]
    }
  ]
}

Was this page helpful?

Suggest edits Raise issue

Bulk Cancel Workflows List message logs

curl https://qstash.upstash.io/v2/workflows/logs \
  -H "Authorization: Bearer <token>"

{
  "cursor": "1686652644442-12",
  "runs": [
    {
      "workflowRunId": "wfr_rj0Upr1rvdzGfz96fXNHh",
      "workflowUrl": "https://feasible-eft-notably.ngrok-free.app/api/call",
      "workflowState": "RUN_SUCCESS",
      "workflowRunCreatedAt": 1736340463061,
      "workflowRunCompletedAt": 1736340464684,
      "steps": [
        {
          "steps": [
            {
              "stepName": "init",
              "stepType": "Initial",
              "callType": "step",
              "messageId": "msg_7YoJxFpwkEy5zBp378JgvD6YBDPBEqkBPje2JGTCEUiASMJQ1FwY9",
              "concurrent": 1,
              "state": "STEP_SUCCESS",
              "createdAt": 1736340463064
            }
          ],
          "type": "sequential"
        },
        {
          "steps": [
            {
              "stepId": 1,
              "stepName": "external call",
              "stepType": "Run",
              "callType": "step",
              "messageId": "msg_26hZCxZCuWyyTWPmSVBrNCtiJGNsULmt63vFfcZxQ3sfYFKLZe2dKww4BSb2kVF",
              "out": "1",
              "concurrent": 2,
              "state": "STEP_SUCCESS",
              "createdAt": 1736340464111
            },
            {
              "stepId": 2,
              "stepName": "external call 2",
              "stepType": "Run",
              "callType": "step",
              "messageId": "msg_26hZCxZCuWyyTWPmSVBrNB882AMRP1TsgzpygELRcLWep4ACNTTsCHhrZuaNLij",
              "out": "2",
              "concurrent": 2,
              "state": "STEP_SUCCESS",
              "createdAt": 1736340463895
            }
          ],
          "type": "parallel"
        }
      ]
    }
  ]
}

Workflow

​Request

​Response

Request

Response