GET
/
admin
/
workflows-executions
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.workflowExecution.list()
.then(({ workflow_executions, count, limit, offset }) => {
  console.log(workflow_executions)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "workflow_executions": [
    {
      "id": "<string>",
      "workflow_id": "<string>",
      "transaction_id": "<string>",
      "execution": {
        "steps": {}
      },
      "context": {
        "data": {
          "invoke": {},
          "payload": "<any>"
        },
        "compensate": {},
        "errors": [
          {
            "error": {},
            "action": "<string>",
            "handlerType": "<string>"
          }
        ]
      },
      "state": "not_started",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
transaction_id

Filter by a transaction ID.

​
workflow_id

Filter by a workflow ID.

​
q
string

Search query to filter by a workflow execution's searchable fields.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

OK

The paginated list of workflow executions.

​
limit
number
required

The maximum number of items returned.

​
offset
number
required

The number of items skipped before retrieving the returned items.

​
count
number
required

The total number of items.

​
workflow_executions
object[]
required

The workflows execution's workflow executions.