How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Medusa Workflows Executions API

These API routes allow you to track workflow executions in your Medusa application.Depending on the workflow engine you use, executions may only be retained for a short while, or only until the Medusa application is restarted.

Medusa Workflows Executions API is one of 82 APIs that Medusa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows Executions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 8 operations across 8 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 2.19.0.

Requests are made against 2 base URLs: http://localhost:9000, https://api.medusajs.com.

8 operations 8 paths 9 schemas 5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.19.0
Base URL
https://{medusa-backend-domain}
Authentication
HTTP Basic, HTTP Bearer, API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 4

Medusa Workflows Executions API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (api_token). It accepts HTTP bearer tokens (jwt_token). An API key is passed in the cookie as connect.sid (cookie_auth). It accepts HTTP bearer tokens (reset_password).

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Workflows Executions 8

These API routes allow you to track workflow executions in your Medusa application. Depending on the workflow engine you use, executions may only be retained for a short while, or…

GET
/admin/workflows-executions
List Workflows Executions
GetWorkflowsExecutions 10 params → 200400401404409422500
GET
/admin/workflows-executions/{id}
Get a Workflows Execution
GetWorkflowsExecutionsId 2 params → 200400401404409422500
POST
/admin/workflows-executions/{workflow_id}/run
Execute a Workflow
PostWorkflowsExecutionsWorkflow_idRun 1 param body → 200400401404409422500
POST
/admin/workflows-executions/{workflow_id}/steps/failure
Fail a Step in a Workflow's Execution
PostWorkflowsExecutionsWorkflow_idStepsFailure 1 param body → 200400401404409422500
POST
/admin/workflows-executions/{workflow_id}/steps/success
Succeed a Step in a Workflow's Execution
PostWorkflowsExecutionsWorkflow_idStepsSuccess 1 param body → 200400401404409422500
GET
/admin/workflows-executions/{workflow_id}/subscribe
Subscribe to a Workflow's Execution
GetWorkflowsExecutionsWorkflow_idSubscribe 1 param → 200400401404409422500
GET
/admin/workflows-executions/{workflow_id}/{transaction_id}
Get Workflow Execution's Details
GetWorkflowsExecutionsWorkflow_idTransaction_id 3 params → 200400401404409422500
GET
/admin/workflows-executions/{workflow_id}/{transaction_id}/subscribe
Subscribe to Workflow Execution Events
GetWorkflowsExecutionsWorkflow_idTransaction_idSubscribe 2 params → 200400401404409422500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are WorkflowExecutionDefinition (13 properties), AdminWorkflowExecution (9 properties), AdminCreateWorkflowsAsyncResponse (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

WorkflowExecutionDefinition
object
The step's definition details.
13 properties
WorkflowExecutionFn
object
The state of the step's invokation function.
2 properties 2 required
AdminWorkflowExecution
object
The workflows execution's details.
9 properties 8 required
AdminWorkflowExecutionExecution
object
The workflow execution's steps details.
1 property 1 required
Error
object
3 properties
AdminCreateWorkflowsAsyncResponse
object
The details of changing a workflow execution's step status.
5 properties 2 required
AdminWorkflowExecutionResponse
object
The workflow execution's details.
1 property 1 required
AdminCreateWorkflowsRun
object
The details of the workflow to execute.
2 properties
WorkflowExecutionContext
object
The workflow execution's context.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

medusa-workflows-executions-api-openapi.yml Raw ↑

Other APIs Medusa publishes across the network.

Medusa GraphQL API
Medusa MCP Remote Server
Medusa Api Keys API
Medusa Auth API
Medusa [auth Provider] API
Medusa Campaigns API
Medusa Carts API
Medusa Claims API
Medusa Collections API
Medusa Currencies API
Medusa Customer Groups API
Medusa Customers API
Where this information came from

This is an independent, third-party profile of Medusa Workflows Executions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.