Heron

Heron Workflows API

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

GitHub OpenAPI

Operations 26

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

Documentation

📖
Documentation
https://docs.herondata.io/
📖
APIReference
https://docs.herondata.io/api-reference/authentication
📖
GettingStarted
https://docs.herondata.io/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/authentication/heron-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/openapi/heron-workflows-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/asyncapi/heron-webhooks-asyncapi.yml

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/llms/heron-llms.txt
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/asyncapi/heron-webhooks-asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/heron:heron-workflows-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

heron-workflows-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@herondata.io
    name: Support
  title: Heron Data Workflows API
  version: '2021-07-19'
servers:
- description: Production
  url: https://app.herondata.io
security:
- ApiKeyAuth:
  - key_XXX
tags:


# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/openapi/heron-workflows-api-openapi.yml