/
HE
herondata
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Analytics
1
AppStore
1
Authentication
1
Brokers
7
BrokerSubmissions
6
Categories
1
Clear
5
Courts
1
Credentials
5
CrmIntegrations
3
EmailTemplates
3
EndUserAccounts
2
EndUserAttributes
1
EndUserCalculations
18
EndUserDataSourceAccounts
3
EndUserDataSources
4
EndUserEmails
1
EndUserEnrichers
5
EndUserEntity
18
EndUserFiles
25
EndUserFinancials
1
EndUserIntegrations
16
EndUserQueries
1
EndUserRules
1
EndUsers
36
EnrichedTransactions
2
EnrichmentFeedback
4
FileClass
5
FraudNetwork
21
Funders
3
Integrations
13
Interaction Logs
1
ISOApplication
6
MCP endpoints
3
Merchants
6
OAuth
1
ParsedEndUserSubmission
1
Policy
5
Policy Backtests
5
Policy Versions
16
Positions
7
Rules
5
Secretary of State
1
Tags
9
Testing
5
Transactions
4
UserMerchantGroups
1
Users
6
Watermarks
2
Webhooks
8
Workflows
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
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}/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)
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_sources
Invalidate PDF cache sources
put
/api/integrations/pdfs/{heron_id}/admin/summary_parser_result/{summary_parser_id}
Amend a summary parser result
Workflows
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Get a workflow by heron ID (admin only)
get
/api/workflow/{workflow_heron_id}
Nov 3, 2026
bd8008e49534
Revision changes
info
endpoint added