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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Heron

Heron Workflows API

The Workflows API from Heron — 22 operation(s) for workflows.

Documentation Provider Profile APIs.io OpenAPI GitHub

Heron Workflows API is one of 48 APIs that Heron publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 26 operations across 22 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 2021-07-19.

Requests are made against a single base URL, https://app.herondata.io.

26 operations 22 paths 33 schemas 2 DELETE12 GET2 PATCH10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2021-07-19
Base URL
https://app.herondata.io/api
Authentication
API Key
Contact
Support
Resource Areas
1

Authentication & Security 1

Heron Workflows API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 26

Across 22 paths, the API surfaces 26 operations — 2 DELETE, 12 GET, 2 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Workflows 26
GET
/api/workflow/executions/status/{workflow_execution_heron_id}
Get the status of a workflow execution (admin only)
1 param → 200404
POST
/api/workflow/node/execute
Execute a single workflow node in isolation
body → 200400404
GET
/api/workflow/node/executions/{workflow_execution_heron_id}
Get single node execution status and result
1 param → 200404
GET
/api/workflow/nodes
List all available workflow nodes
1 param → 200400404
POST
/api/workflow/start
Start a workflow for an end user
body → 200404
POST
/api/workflow/start_by_heron_id
Start a workflow by Heron ID for an end user
body → 200400404
POST
/api/workflow/start_by_name
Start a workflow by name for an end user
body → 200400404
GET
/api/workflow/user/workflows
List workflows for the current user
→ 200
GET
/api/workflow/users/{user_id}/workflows
List all workflows for a user (admin only)
1 param → 200404
POST
/api/workflow/users/{user_id}/workflows
Create a new workflow for a user (admin only)
1 param body → 201400404409
GET
/api/workflow/users/{user_id}/workflows/{workflow_heron_id}
Get a specific workflow for a user (admin only)
2 params → 200404
GET
/api/workflow/workflows
List all workflows across all users (admin only)
→ 200
DELETE
/api/workflow/{heron_id}
Delete a workflow by heron ID (admin only)
1 param → 200404
GET
/api/workflow/{workflow_heron_id}
Get a workflow by heron ID (admin only)
1 param → 200404
PATCH
/api/workflow/{workflow_heron_id}
Update a workflow by heron ID (admin only)
1 param body → 200400404
GET
/api/workflow/{workflow_heron_id}/executions
Get recent workflow executions for a workflow (admin only)
1 param → 200
GET
/api/workflow/{workflow_heron_id}/executions/end_user/{end_user_heron_id}
Get the status of a workflow execution (admin only)
2 params → 200404
GET
/api/workflow/{workflow_heron_id}/node/{node_id}/executions
List all single-node executions for a node
3 params → 200404
DELETE
/api/workflow/{workflow_heron_id}/versions/{version_number}
Delete a draft workflow version by heron ID (admin only)
2 params → 204400404
GET
/api/workflow/{workflow_heron_id}/versions/{version_number}
Get workflow version details (admin only)
2 params → 200404
PATCH
/api/workflow/{workflow_heron_id}/versions/{version_number}
Update a draft workflow version in-place (admin only)
2 params body → 200400404
POST
/api/workflow/{workflow_heron_id}/versions/{version_number}/approve
Approve a workflow version in review (admin only)
2 params body → 200400404
POST
/api/workflow/{workflow_heron_id}/versions/{version_number}/copy_to_draft
Copy a version to a new draft (admin only)
2 params body → 201400404
POST
/api/workflow/{workflow_heron_id}/versions/{version_number}/publish
Publish a workflow draft directly (admin only)
2 params body → 200400404
POST
/api/workflow/{workflow_heron_id}/versions/{version_number}/submit_for_review
Submit a workflow draft for review (admin only)
2 params body → 200400404
POST
/api/workflow/{workflow_heron_id}/versions/{version_number}/withdraw
Withdraw a workflow version from review (admin only)
2 params → 200400404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are WorkflowSummarySchema (21 properties), NodeMetadataSchema (16 properties), WorkflowVersionSchema (15 properties), WorkflowVersionSummary (13 properties). Each schema is shown below with its type and property counts.

WorkflowStartByNameRequestSchema
object
5 properties 2 required
WorkflowUpdateVersionSchema
object
4 properties
JSONWorkflowNode
object
7 properties 3 required
WorkflowSubmitForReviewSchema
object
1 property 1 required
WorkflowExecutionSchema
object
10 properties
WorkflowStartResponseSchema
object
4 properties
WorkflowStartRequestSchema
object
7 properties 1 required
WorkflowSummarySchema
object
21 properties
WorkflowExecutionStatusSchema
object
2 properties
JSONWorkflowEdge
object
4 properties 2 required
WorkflowSchema
object
12 properties
WorkflowApproveSchema
object
2 properties 1 required
NodeMetadataSchema
object
16 properties 14 required
UserWorkflowSchema
object
7 properties
WorkflowCreateSchema
object
5 properties 2 required
WorkflowUpdateSchema
object
5 properties
WorkflowPublishSchema
object
1 property 1 required
SingleNodeExecuteRequestSchema
object
7 properties 3 required
JSONWorkflowDefinition
object
6 properties
SingleNodeExecuteResponseSchema
object
3 properties
Handle
object
2 properties 2 required
WorkflowStartByHeronIdRequestSchema
object
5 properties 2 required
WorkflowCopyToDraftSchema
object
1 property
WorkflowVersionSummary
object
13 properties
LocalVariable
object
3 properties 3 required
SingleNodeExecutionListItemSchema
object
6 properties
WorkflowVersionSchema
object
15 properties
JSONWorkflowErrorHandling
object
3 properties
FlowmingoWorkflowOwners
object
2 properties
CachePolicyDefinition
object
3 properties 3 required
WorkflowNodeStatus
object
11 properties
JSONWorkflowNodeSettings
object
4 properties
NodeCacheSettings
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heron-workflows-api-openapi.yml Raw ↑

Other APIs Heron publishes across the network.

Heron Analytics API
AE Profile APIs.io
Heron App Store API
AE Profile APIs.io
Heron Authentication API
AE Profile APIs.io
Heron Broker Funder Policies API
AE Profile APIs.io
Heron Broker Submissions API
AE Profile APIs.io
Heron Categories API
AE Profile APIs.io
Heron Clear API
AE Profile APIs.io
Heron Credentials API
AE Profile APIs.io
Heron CRM Integrations API
AE Profile APIs.io
Heron Email Templates API
AE Profile APIs.io
Heron End Users API
AE Profile APIs.io
Heron End User Accounts API
AE Profile APIs.io
#Workflows
← Back to H APIs
API Details
ID
heron:heron-workflows-api
Base URL
https://app.herondata.io/api
Docs
https://docs.herondata.io/
Provider
Heron
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=heron-workflows-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/heron-workflows-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Heron Workflows 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.