/

Docs
History
Schema
Generate

Filter operations

Analytics1

AppStore1

Authentication1

Brokers7

BrokerSubmissions6

Categories1

Clear5

Courts1

Credentials5

CrmIntegrations3

EmailTemplates3

EndUserAccounts2

EndUserAttributes1

EndUserCalculations18

EndUserDataSourceAccounts3

EndUserDataSources4

EndUserEmails1

EndUserEnrichers5

EndUserEntity18

EndUserFiles25

EndUserFinancials1

EndUserIntegrations16

EndUserQueries1

EndUserRules1

EndUsers36

EnrichedTransactions2

EnrichmentFeedback4

FileClass5

FraudNetwork21

Funders3

Integrations13

Interaction Logs1

ISOApplication6

MCP endpoints3

Merchants6

OAuth1

ParsedEndUserSubmission1

Policy5

Policy Backtests5

Policy Versions16

Positions7

Rules5

Secretary of State1

Tags9

Testing5

Transactions4

UserMerchantGroups1

Users6

Watermarks2

Webhooks8

Workflows26

get/api/workflow/executions/status/{workflow_execution_heron_id}Get the status of a workflow execution (admin only)
post/api/workflow/node/executeExecute 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/nodesList all available workflow nodes
post/api/workflow/startStart a workflow for an end user
post/api/workflow/start_by_heron_idStart a workflow by Heron ID for an end user
post/api/workflow/start_by_nameStart a workflow by name for an end user
get/api/workflow/user/workflowsList workflows for the current user
get/api/workflow/users/{user_id}/workflowsList all workflows for a user (admin only)
post/api/workflow/users/{user_id}/workflowsCreate 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/workflowsList 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}/executionsGet 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}/executionsList all single-node executions for a node
get/api/workflow/{workflow_heron_id}/versions/{version_number}Get workflow version details (admin only)
delete/api/workflow/{workflow_heron_id}/versions/{version_number}Delete a draft workflow version by heron ID (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}/approveApprove a workflow version in review (admin only)
post/api/workflow/{workflow_heron_id}/versions/{version_number}/copy_to_draftCopy a version to a new draft (admin only)
post/api/workflow/{workflow_heron_id}/versions/{version_number}/publishPublish a workflow draft directly (admin only)
post/api/workflow/{workflow_heron_id}/versions/{version_number}/submit_for_reviewSubmit a workflow draft for review (admin only)
post/api/workflow/{workflow_heron_id}/versions/{version_number}/withdrawWithdraw a workflow version from review (admin only)

get/api/broker/end_users/{end_user_heron_id}/funder_submissions/List funder submissions with their current decision and offers
get/api/broker/end_users/{end_user_heron_id}/funder_submissions/preflight/Validate an end user for configured funders
post/api/broker/end_users/{end_user_heron_id}/funder_submissions/submit_to_funders/Submit an end user to multiple funders
post/api/broker/end_users/{end_user_heron_id}/funder_submissions/{submission_heron_id}/exclusion_resolution/Resolve a held funder submission
get/api/broker_funder_policies/List broker funder policies for current user
patch/api/broker_funder_policies/Bulk update broker funder policies
get/api/broker_funder_policies/export/Export broker funder policies as Excel
post/api/broker_funder_policies/funders/Add a funder to broker's policies
delete/api/broker_funder_policies/funders/{funder_heron_id}/Remove a funder from broker's policies
post/api/broker_funder_policies/upload/Upload funder policy file for parsing
get/api/broker_funder_policies/upload/status/Get policy upload job status
get/api/broker_funder_policies/upload/{job_heron_id}/Get specific policy upload job
get/api/broker_funder_policies/upload/{job_heron_id}/pending/List pending funder matches for a job
post/api/broker_funder_policies/upload/{job_heron_id}/pending/{index}/resolve/Resolve a pending funder match
post/api/broker_funder_policies/upload/{job_heron_id}/pending/{index}/skip/Skip a pending funder match
get/api/end_users/{end_user_heron_id}/deal_link/Get deal link entries for an end user
get/api/end_users/{end_user_heron_id}/funder_policy_evaluations/List funder policy evaluations for an end user
post/api/end_users/{end_user_heron_id}/funder_submissions/{submission_heron_id}/submit_to_funder/Submit an end user to a single funder
get/api/funder_exclusion_rules/List funder exclusion rules
post/api/funder_exclusion_rules/bulk/Add sender matchers to many funder exclusion rules
delete/api/funder_exclusion_rules/bulk/Delete many funder exclusion rules
patch/api/funder_exclusion_rules/bulk/Add and remove sender matchers across many funder exclusion rules
put/api/funder_exclusion_rules/{funder_heron_id}/Create or replace a funder exclusion rule
delete/api/funder_exclusion_rules/{funder_heron_id}/Delete a funder exclusion rule
get/api/funder_integrations/List funder integration states for the current broker
post/api/funder_integrations/Link a funder to the current broker for self-service
get/api/funder_integrations/candidates/List funders available for self-service that the broker hasn't linked yet
put/api/funder_integrations/{funder_heron_id}/Save staging or production form values for a funder integration
delete/api/funder_integrations/{funder_heron_id}/Remove a funder, or delete one environment's saved integration
patch/api/funder_integrations/{funder_heron_id}/Update a funder's submission channel and email configuration
post/api/funder_integrations/{funder_heron_id}/test/Trigger a staging or production test submission for this funder
post/api/funder_submissions/Upsert a funder submission
get/api/funder_submissions/{submission_heron_id}/Get funder submission status
post/api/funder_submissions/{submission_heron_id}/trigger/Trigger a funder submission
get/api/funders/search/Search funders by name
post/api/ingestion/crm/{crm_integration_heron_id}Ingest end user data from a CRM webhook
post/api/integrations/pdfs/admin/invalidate_cache_sourcesInvalidate PDF cache sources
put/api/integrations/pdfs/{heron_id}/admin/summary_parser_result/{summary_parser_id}Amend a summary parser result

Workflows

Changes to Start a workflow for an end user

post/api/workflow/start

Nov 3, 2026bd8008e49534 Revision changes
- info
  endpoint added