Whether the end user is part of a lending portfolio
Example:
true
order_by
enum<string> | null
default:last_updated_desc
Order to return end users by
Available options:
last_updated_desc,
last_updated_asc,
created_desc,
created_asc,
null
heron_id
string | null
Unique ID generated by Heron
Example:
"eus_9qQBmrBQMMUkek76UmiQ7m"
end_user_id
string | null
Filter by ID associated with end_user_id field in transactions
Example:
"your_end_user_id"
tags
string[] | null
Filter by tag Heron IDs. End users holding any active requested tag are returned. Unknown and soft-deleted tag IDs do not match any end users.
page
integer | null
Pagination page number (optional). If provided, 'limit' must also be provided.
Required range: x >= 1
limit
integer | null
Pagination limit per page (optional). If provided, 'page' must also be provided.
Required range: 1 <= x <= 10000
include_tags
boolean
default:false
Whether to include the tags applied to each end user
Example:
true
with_policy_result
any | null
Only end users whose policy result was this.
Available options:
passed,
failed,
review_required,
missing_data,
execution_error,
null
with_crm_sync_result
any | null
Available options:
success,
failure,
no_sync_attempted,
null
in_human_review
boolean | null
Filter by whether an active document is pending human review
include_submitting_brokers
boolean
default:false
Whether to include the brokers who submitted each end user
Example:
true
lendsaas_deal_ids
string[] | null
Only end users linked to any of these LendSaaS deal IDs. Requires a LendSaaS CRM integration.
Required array length: 1 - 100 elements
Minimum string length: 1
include_lendsaas_deal_ids
boolean
default:false
Whether to include the LendSaaS deal IDs linked to each end user
Example:
true
include_crm_queue
boolean
default:false
Whether to include the CRM queue each end user's workflow last synced it to (currently read from LendSaaS sync steps)
Example:
true
interval_start
string<date-time> | null
interval_end
string<date-time> | null
include_updates_in_interval
boolean
default:false
When true, interval_start and interval_end match end users created or last updated within the window. Bounds are inclusive only when this flag is true.
Response
200 - application/json
OK
_meta
object
Pagination metadata. Present only if pagination parameters ('page' and 'limit') are provided in the request.
Show child attributes
end_users
object[]
Show child attributes
Was this page helpful?
⌘I
List EndUsers with Summary Information
curl --request GET \ --url https://app.herondata.io/api/end_users/summary \ --header 'x-api-key: <api-key>'
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Heron","colors":{"primary":"#CD461D","light":"#FF835E","dark":"#CD461D"},"logo":{"light":"https://mintcdn.com/herondata/AkuG3WZNjPMLrlAs/logo/light.svg?fit=max\u0026auto=format\u0026n=AkuG3WZNjPMLrlAs\u0026q=85\u0026s=3fdaeef2943a89b32ca67895d004d0b9","dark":"https://mintcdn.com/herondata/AkuG3WZNjPMLrlAs/logo/dark.svg?fit=max\u0026auto=format\u0026n=AkuG3WZNjPMLrlAs\u0026q=85\u0026s=3e602c236a03e92457e96c309ce44d03","href":"https://herondata.io"},"favicon":"https://mintcdn.com/herondata/AkuG3WZNjPMLrlAs/favicon.svg?fit=max\u0026auto=format\u0026n=AkuG3WZNjPMLrlAs\u0026q=85\u0026s=d4ad7da2a98a69e7d704364b0877e1a5","background":{"color":{"light":"#F9FAF0","dark":"#15160C"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.herondata.io"}},"footer":{"socials":{"github":"https://github.com/herondata","linkedin":"https://www.linkedin.com/company/heron-data"}},"fonts":{"family":"Season Sans","weight":400,"source":"fonts/SeasonSans-Regular.woff2","format":"woff2"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Heron","icon":"house","href":"https://herondata.io"},{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.herondata.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"herondata","hasAudioNarration":false,"actualSubdomain":"herondata","customDomains":["docs.herondata.io"],"gitSource":{"type":"github","owner":"heron-data","repo":"mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b0234bd7f78b46ac096c43d","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":319},{"language":"default","tag":"EndUsers","count":33},{"language":"default","tag":"Documentation","count":27},{"language":"default","tag":"EndUserFiles","count":23},{"language":"default","tag":"EndUserCalculations","count":18},{"language":"default","tag":"Integrations","count":17},{"language":"default","tag":"EndUserEntity","count":17},{"language":"default","tag":"EndUserIntegrations","count":16},{"language":"default","tag":"Policy Versions","count":9},{"language":"default","tag":"Tags","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Season Sans\";src:url(\"/fonts/SeasonSans-Medium.woff2\") format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}h1,h2,h3,h4,h5,h6,strong,b,.font-semibold,.font-bold{font-weight:500}html:not(.dark) #content-area,html:not(.dark) #content.prose{color:#4a1809;--tw-prose-body: #4a1809;--tw-prose-headings: #4a1809;--tw-prose-lead: #4a1809;--tw-prose-bold: #4a1809;--tw-prose-counters: #4a1809;--tw-prose-bullets: rgb(74 24 9 / 0.5);--tw-prose-th-borders: rgb(74 24 9 / 0.2);--tw-prose-td-borders: rgb(74 24 9 / 0.12)}html:not(.dark) #content-area :not(pre)>code{background-color:#ebedd9;border-color:#dcdfbe}html.dark #content-area :not(pre)>code{background-color:#2d2e20;border-color:#5a5c40}.sidebar-group a{font-weight:500}html:not(.dark) .sidebar-group a.text-gray-700{color:rgb(74 24 9 / 0.72)}#content-area :not(code,pre,kbd,pre *),#sidebar-content :not(code,kbd),#table-of-contents-content a{font-weight:500}"}]}
{"page":{"pagePath":"api-reference/endusers/list-endusers-with-summary-information","slug":"/api-reference/endusers/list-endusers-with-summary-information","pageMetadata":{"title":"List EndUsers with Summary Information","description":"Get a list of EndUsers","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/summary","href":"/api-reference/endusers/list-endusers-with-summary-information","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get a list of EndUsers\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List EndUsers with Summary Information","description":"Get a list of EndUsers","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/summary","href":"/api-reference/endusers/list-endusers-with-summary-information","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Get a list of EndUsers","parameters":["e0daa979-eef7-4737-8321-d36d6a895d36","ac1c60c0-2939-48aa-b24d-090c67d41b19","7e0afbd0-9794-4e41-90b7-19bfce6596c1","0693655c-53ff-46f8-a3a4-1588c5a1d6b2","18373edb-a281-48c9-87f5-f894dc3627f6","ce74507d-a3ef-4d28-a838-58075bec67eb","a56c1f34-b8a0-4b13-8548-1c2dde8551dd","6f2975a3-4a41-4ea0-9525-217ec029368b","e78767ba-5d95-4353-b2ea-35b2b534d6a2","144d20ae-e509-4ef8-b574-12f3187d0d37","1db034a4-debd-445e-8432-99cc6062ddcc","1a5100f3-12f4-47d3-8f4d-60fa56ac7b59","0390b73e-98a5-427d-8729-71d3eeda4d21","1b594933-b0a9-4b0c-bef0-08a059f32adf","7f73d2d4-f7d6-4abe-9cda-f4c2a4425ca6","0aebda40-1376-4bbe-92fa-669c87b5f1fb","14899620-ce63-43b9-803d-628f8495e114","57453cb4-3a1e-4806-bf15-72c75dae0ee4","ccc09923-0172-4892-b147-75ba3561f230","27b20286-ab7c-4ac0-9c21-3527844486f1"],"responses":{"200":"129614aa-a14f-451e-b14c-9ce74d1d328c"},"security":["71e9a0b0-e11a-4bfb-8f9e-b2f3c68b4137"],"summary":"List EndUsers with Summary Information","tags":["EndUsers"],"method":"get","type":"path","servers":["4e631a23-aace-4608-8544-b52193510c5d"],"path":"/api/end_users/summary","baseUrlOptions":["https://app.herondata.io"],"title":"List EndUsers with Summary Information","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e0daa979-eef7-4737-8321-d36d6a895d36":{"description":"Filter by name associated with end user","in":"query","name":"name","required":false,"schema":{"oneOf":[{"example":"your_end_user_name","type":"string","description":"Filter by name associated with end user","uniqueKey":"oneOf.0","typeLabel":"string"},{"example":"your_end_user_name","type":"null","description":"Filter by name associated with end user","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"ac1c60c0-2939-48aa-b24d-090c67d41b19":{"description":"Filter by status of end user","in":"query","name":"status","required":false,"schema":{"oneOf":[{"enum":["new","ready","processed","reviewed","review_requested","failed",null],"example":"reviewed","type":"string","description":"Filter by status of end user","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["new","ready","processed","reviewed","review_requested","failed",null],"example":"reviewed","type":"null","description":"Filter by status of end user","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"7e0afbd0-9794-4e41-90b7-19bfce6596c1":{"description":"Whether the end user is part of a lending portfolio","in":"query","name":"is_portfolio","required":false,"schema":{"oneOf":[{"example":true,"type":"boolean","description":"Whether the end user is part of a lending portfolio","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"example":true,"type":"null","description":"Whether the end user is part of a lending portfolio","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"0693655c-53ff-46f8-a3a4-1588c5a1d6b2":{"description":"Order to return end users by","in":"query","name":"order_by","required":false,"schema":{"oneOf":[{"default":"last_updated_desc","enum":["last_updated_desc","last_updated_asc","created_desc","created_asc",null],"type":"string","description":"Order to return end users by","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"default":"last_updated_desc","enum":["last_updated_desc","last_updated_asc","created_desc","created_asc",null],"type":"null","description":"Order to return end users by","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"18373edb-a281-48c9-87f5-f894dc3627f6":{"description":"Unique ID generated by Heron","in":"query","name":"heron_id","required":false,"schema":{"oneOf":[{"example":"eus_9qQBmrBQMMUkek76UmiQ7m","type":"string","description":"Unique ID generated by Heron","uniqueKey":"oneOf.0","typeLabel":"string"},{"example":"eus_9qQBmrBQMMUkek76UmiQ7m","type":"null","description":"Unique ID generated by Heron","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"ce74507d-a3ef-4d28-a838-58075bec67eb":{"description":"Filter by ID associated with end_user_id field in transactions","in":"query","name":"end_user_id","required":false,"schema":{"oneOf":[{"example":"your_end_user_id","type":"string","description":"Filter by ID associated with end_user_id field in transactions","uniqueKey":"oneOf.0","typeLabel":"string"},{"example":"your_end_user_id","type":"null","description":"Filter by ID associated with end_user_id field in transactions","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"a56c1f34-b8a0-4b13-8548-1c2dde8551dd":{"description":"Filter by tag Heron IDs. End users holding any active requested tag are returned. Unknown and soft-deleted tag IDs do not match any end users.","explode":true,"in":"query","name":"tags","required":false,"schema":{"oneOf":[{"items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"type":"array","description":"Filter by tag Heron IDs. End users holding any active requested tag are returned. Unknown and soft-deleted tag IDs do not match any end users.","uniqueKey":"oneOf.0","typeLabel":"string[]"},{"items":{"type":"string"},"type":"null","description":"Filter by tag Heron IDs. End users holding any active requested tag are returned. Unknown and soft-deleted tag IDs do not match any end users.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"},"style":"form"},"6f2975a3-4a41-4ea0-9525-217ec029368b":{"description":"Pagination page number (optional). If provided, 'limit' must also be provided.","in":"query","name":"page","required":false,"schema":{"oneOf":[{"minimum":1,"type":"integer","description":"Pagination page number (optional). If provided, 'limit' must also be provided.","uniqueKey":"oneOf.0","typeLabel":"integer"},{"minimum":1,"type":"null","description":"Pagination page number (optional). If provided, 'limit' must also be provided.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"}},"e78767ba-5d95-4353-b2ea-35b2b534d6a2":{"description":"Pagination limit per page (optional). If provided, 'page' must also be provided.","in":"query","name":"limit","required":false,"schema":{"oneOf":[{"maximum":10000,"minimum":1,"type":"integer","description":"Pagination limit per page (optional). If provided, 'page' must also be provided.","uniqueKey":"oneOf.0","typeLabel":"integer"},{"maximum":10000,"minimum":1,"type":"null","description":"Pagination limit per page (optional). If provided, 'page' must also be provided.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"}},"144d20ae-e509-4ef8-b574-12f3187d0d37":{"description":"Whether to include the tags applied to each end user","in":"query","name":"include_tags","required":false,"schema":{"default":false,"example":true,"type":"boolean","isRequired":false,"description":"Whether to include the tags applied to each end user","uniqueKey":"","typeLabel":"boolean"}},"1db034a4-debd-445e-8432-99cc6062ddcc":{"description":"Only end users whose policy result was this.","in":"query","name":"with_policy_result","required":false,"schema":{"oneOf":[{"enum":["passed","failed","review_required","missing_data","execution_error",null],"description":"Only end users whose policy result was this.","uniqueKey":"oneOf.0","typeLabel":"any"},{"enum":["passed","failed","review_required","missing_data","execution_error",null],"type":"null","description":"Only end users whose policy result was this.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"any | null"}},"1a5100f3-12f4-47d3-8f4d-60fa56ac7b59":{"in":"query","name":"with_crm_sync_result","required":false,"schema":{"oneOf":[{"enum":["success","failure","no_sync_attempted",null],"uniqueKey":"oneOf.0","typeLabel":"any"},{"enum":["success","failure","no_sync_attempted",null],"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"any | null"}},"0390b73e-98a5-427d-8729-71d3eeda4d21":{"description":"Filter by whether an active document is pending human review","in":"query","name":"in_human_review","required":false,"schema":{"oneOf":[{"type":"boolean","description":"Filter by whether an active document is pending human review","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Filter by whether an active document is pending human review","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"1b594933-b0a9-4b0c-bef0-08a059f32adf":{"description":"Whether to include the brokers who submitted each end user","in":"query","name":"include_submitting_brokers","required":false,"schema":{"default":false,"example":true,"type":"boolean","isRequired":false,"description":"Whether to include the brokers who submitted each end user","uniqueKey":"","typeLabel":"boolean"}},"7f73d2d4-f7d6-4abe-9cda-f4c2a4425ca6":{"description":"Only end users linked to any of these LendSaaS deal IDs. Requires a LendSaaS CRM integration.","explode":true,"in":"query","name":"lendsaas_deal_ids","required":false,"schema":{"oneOf":[{"items":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":100,"minItems":1,"type":"array","description":"Only end users linked to any of these LendSaaS deal IDs. Requires a LendSaaS CRM integration.","uniqueKey":"oneOf.0","typeLabel":"string[]"},{"items":{"minLength":1,"type":"string"},"maxItems":100,"minItems":1,"type":"null","description":"Only end users linked to any of these LendSaaS deal IDs. Requires a LendSaaS CRM integration.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"},"style":"form"},"0aebda40-1376-4bbe-92fa-669c87b5f1fb":{"description":"Whether to include the LendSaaS deal IDs linked to each end user","in":"query","name":"include_lendsaas_deal_ids","required":false,"schema":{"default":false,"example":true,"type":"boolean","isRequired":false,"description":"Whether to include the LendSaaS deal IDs linked to each end user","uniqueKey":"","typeLabel":"boolean"}},"14899620-ce63-43b9-803d-628f8495e114":{"description":"Whether to include the CRM queue each end user's workflow last synced it to (currently read from LendSaaS sync steps)","in":"query","name":"include_crm_queue","required":false,"schema":{"default":false,"example":true,"type":"boolean","isRequired":false,"description":"Whether to include the CRM queue each end user's workflow last synced it to (currently read from LendSaaS sync steps)","uniqueKey":"","typeLabel":"boolean"}},"57453cb4-3a1e-4806-bf15-72c75dae0ee4":{"in":"query","name":"interval_start","required":false,"schema":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"ccc09923-0172-4892-b147-75ba3561f230":{"in":"query","name":"interval_end","required":false,"schema":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"27b20286-ab7c-4ac0-9c21-3527844486f1":{"description":"When true, interval_start and interval_end match end users created or last updated within the window. Bounds are inclusive only when this flag is true.","in":"query","name":"include_updates_in_interval","required":false,"schema":{"default":false,"type":"boolean","isRequired":false,"description":"When true, interval_start and interval_end match end users created or last updated within the window. Bounds are inclusive only when this flag is true.","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"129614aa-a14f-451e-b14c-9ce74d1d328c":{"content":{"application/json":{"schema":{"properties":{"_meta":{"type":"object","description":"Pagination metadata. Present only if pagination parameters ('page' and 'limit') are provided in the request.","properties":{"next_url":{"oneOf":[{"description":"the URL of the next page","format":"url","type":"string","uniqueKey":"_meta.next_url.oneOf.0","typeLabel":"string\u003curl>"},{"description":"the URL of the next page","format":"url","type":"null","uniqueKey":"_meta.next_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"_meta.next_url","typeLabel":"string\u003curl> | null"},"num_results":{"description":"the number of results on this page","type":"integer","uniqueKey":"_meta.num_results","typeLabel":"integer"},"page":{"description":"current page","type":"integer","uniqueKey":"_meta.page","typeLabel":"integer"},"pages":{"description":"the number of pages","type":"integer","uniqueKey":"_meta.pages","typeLabel":"integer"},"per_page":{"description":"the max number of results per page","type":"integer","uniqueKey":"_meta.per_page","typeLabel":"integer"},"prev_url":{"oneOf":[{"description":"the URL of the last page","format":"url","type":"string","uniqueKey":"_meta.prev_url.oneOf.0","typeLabel":"string\u003curl>"},{"description":"the URL of the last page","format":"url","type":"null","uniqueKey":"_meta.prev_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"_meta.prev_url","typeLabel":"string\u003curl> | null"},"total":{"description":"the number of results across all pages","type":"integer","uniqueKey":"_meta.total","typeLabel":"integer"}},"uniqueKey":"_meta","typeLabel":"object"},"end_users":{"items":{"properties":{"end_user_id":{"description":"id defined by user; links to the end_user_id for transactions","example":"7cb48787-6d91-5b9f-bc60-f30298ea5736","maxLength":140,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"end_users.items.[INDEX].end_user_id","typeLabel":"string"},"confidence":{"oneOf":[{"description":"Aggregated confidence for the end user across all transactions; between 0 and 1","example":0.42,"readOnly":true,"type":"number","uniqueKey":"end_users.items.[INDEX].confidence.oneOf.0","typeLabel":"number"},{"description":"Aggregated confidence for the end user across all transactions; between 0 and 1","example":0.42,"readOnly":true,"type":"null","uniqueKey":"end_users.items.[INDEX].confidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].confidence","typeLabel":"number | null"},"created":{"description":"When the end user was created in Heron system","example":"2026-02-26T09:30:00+00:00","format":"date-time","readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].created","typeLabel":"string\u003cdate-time>"},"criteria":{"oneOf":[{"description":"List of scorecard metrics","items":{"properties":{"context":{"oneOf":[{"description":"Context for how to interpret the metric, e.g., whether a higher value is 'better' than a lower value","enum":["higher_is_better","lower_is_better",null],"example":"higher_is_better","type":"string","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Context for how to interpret the metric, e.g., whether a higher value is 'better' than a lower value","enum":["higher_is_better","lower_is_better",null],"example":"higher_is_better","type":"null","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].context","typeLabel":"enum\u003cstring> | null"},"currency":{"oneOf":[{"description":"The ISO currency code for metric, where applicable","type":"string","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].currency.oneOf.0","typeLabel":"string"},{"description":"The ISO currency code for metric, where applicable","type":"null","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].currency","typeLabel":"string | null"},"date_range":{"description":"Metric date range","enum":["latest","last_30_days","last_90_days","last_120_days","last_180_days","last_365_days","next_30_days","next_60_days","next_90_days","next_180_days","last_1_calendar_months","last_3_calendar_months","last_4_calendar_months","last_6_calendar_months","last_12_calendar_months","last_15_calendar_months","last_24_calendar_months","last_1_full_calendar_months","last_2_full_calendar_months","last_3_full_calendar_months","last_6_full_calendar_months","last_12_full_calendar_months","last_60_days","last_45_days","last_2_calendar_months"],"example":"last_180_days","type":"string","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].date_range","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"description":"Description of metric","example":"The number of unique transactions with a timestamp","type":"string","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Description of metric","example":"The number of unique transactions with a timestamp","type":"null","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"group":{"description":"The type of metric","enum":["data_quality","processing_quality","balance","profit_and_loss","debt","risk_flag","forecast","heron","ml_feature"],"example":"data_quality","type":"string","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].group","typeLabel":"enum\u003cstring>"},"label":{"description":"Metric label, slugified","example":"unique_transactions","type":"string","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].label","typeLabel":"string"},"status":{"oneOf":[{"description":"either 'calculated' or 'not_available' depending on the requested date range vs. date range of the data","enum":["available","partially_available","not_available",null],"example":"not_available","type":"string","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].status.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"either 'calculated' or 'not_available' depending on the requested date range vs. date range of the data","enum":["available","partially_available","not_available",null],"example":"not_available","type":"null","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].status","typeLabel":"enum\u003cstring> | null"},"unit":{"description":"The unit of measurement for metric","enum":["n","day","ratio","amount","weekday","array","probability"],"example":"n","type":"string","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].unit","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"description":"The metric value","example":42.42,"uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"The metric value","example":42.42,"type":"null","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX].value","typeLabel":"any | null"}},"type":"object","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.0","typeLabel":"object[]"},{"description":"List of scorecard metrics","items":{"properties":{"context":{"oneOf":[{"description":"Context for how to interpret the metric, e.g., whether a higher value is 'better' than a lower value","enum":["higher_is_better","lower_is_better",null],"example":"higher_is_better","type":"string"},{"description":"Context for how to interpret the metric, e.g., whether a higher value is 'better' than a lower value","enum":["higher_is_better","lower_is_better",null],"example":"higher_is_better","type":"null"}]},"currency":{"oneOf":[{"description":"The ISO currency code for metric, where applicable","type":"string"},{"description":"The ISO currency code for metric, where applicable","type":"null"}]},"date_range":{"description":"Metric date range","enum":["latest","last_30_days","last_90_days","last_120_days","last_180_days","last_365_days","next_30_days","next_60_days","next_90_days","next_180_days","last_1_calendar_months","last_3_calendar_months","last_4_calendar_months","last_6_calendar_months","last_12_calendar_months","last_15_calendar_months","last_24_calendar_months","last_1_full_calendar_months","last_2_full_calendar_months","last_3_full_calendar_months","last_6_full_calendar_months","last_12_full_calendar_months","last_60_days","last_45_days","last_2_calendar_months"],"example":"last_180_days","type":"string"},"description":{"oneOf":[{"description":"Description of metric","example":"The number of unique transactions with a timestamp","type":"string"},{"description":"Description of metric","example":"The number of unique transactions with a timestamp","type":"null"}]},"group":{"description":"The type of metric","enum":["data_quality","processing_quality","balance","profit_and_loss","debt","risk_flag","forecast","heron","ml_feature"],"example":"data_quality","type":"string"},"label":{"description":"Metric label, slugified","example":"unique_transactions","type":"string"},"status":{"oneOf":[{"description":"either 'calculated' or 'not_available' depending on the requested date range vs. date range of the data","enum":["available","partially_available","not_available",null],"example":"not_available","type":"string"},{"description":"either 'calculated' or 'not_available' depending on the requested date range vs. date range of the data","enum":["available","partially_available","not_available",null],"example":"not_available","type":"null"}]},"unit":{"description":"The unit of measurement for metric","enum":["n","day","ratio","amount","weekday","array","probability"],"example":"n","type":"string"},"value":{"oneOf":[{"description":"The metric value","example":42.42},{"description":"The metric value","example":42.42,"type":"null"}]}},"type":"object"},"readOnly":true,"type":"null","uniqueKey":"end_users.items.[INDEX].criteria.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].criteria","typeLabel":"object[] | null"},"crm_queue":{"oneOf":[{"type":"object","description":"The CRM queue the deal's workflow last synced it to; null when none","properties":{"crm_integration_heron_id":{"readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.0.crm_integration_heron_id","typeLabel":"string"},"node_id":{"description":"The CRM sync step that sets the queue","readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.0.node_id","typeLabel":"string"},"status_id":{"oneOf":[{"description":"The status the sync step sends, which the CRM may not apply (e.g. under a priority order)","readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.0.status_id.oneOf.0","typeLabel":"string"},{"description":"The status the sync step sends, which the CRM may not apply (e.g. under a priority order)","readOnly":true,"type":"null","uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.0.status_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.0.status_id","typeLabel":"string | null"},"status_name":{"oneOf":[{"readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.0.status_name.oneOf.0","typeLabel":"string"},{"readOnly":true,"type":"null","uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.0.status_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.0.status_name","typeLabel":"string | null"}},"uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"end_users.items.[INDEX].crm_queue.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].crm_queue","typeLabel":"object | null"},"crm_sync_result":{"oneOf":[{"type":"object","properties":{"crm_record_url":{"oneOf":[{"type":"string","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.crm_record_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.crm_record_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.crm_record_url","typeLabel":"string | null"},"error_message":{"oneOf":[{"type":"string","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.error_message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.error_message","typeLabel":"string | null"},"heron_id":{"type":"string","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.heron_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.name","typeLabel":"string"},"occurred_at":{"format":"date-time","type":"string","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.occurred_at","typeLabel":"string\u003cdate-time>"},"provider":{"oneOf":[{"type":"string","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.provider.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.provider","typeLabel":"string | null"},"result":{"enum":["success","failure","no_sync_attempted"],"type":"string","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.result","typeLabel":"enum\u003cstring>"},"success_message":{"oneOf":[{"type":"string","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.success_message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.success_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0.success_message","typeLabel":"string | null"}},"uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"end_users.items.[INDEX].crm_sync_result.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].crm_sync_result","typeLabel":"object | null"},"data_sources":{"description":"List of data source summaries for the end user","items":{"properties":{"type":{"description":"Data source type","enum":["api","csv","pdf","integration_link","legacy","legacy_pdf","legacy_integration_link"],"example":"pdf","type":"string","isRequired":true,"uniqueKey":"end_users.items.[INDEX].data_sources.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"status":{"description":"Status of the data source entity, where applicable (e.g. pdfs, integration links)","enum":["new","parsing","parsed","processed","human_reviewing","approved","rejected","failed","transactions_loaded","transactions_unloaded","pending","active","syncing","erroring","sync_disabled","deleted_in_plaid","unknown"],"example":"new","type":"string","uniqueKey":"end_users.items.[INDEX].data_sources.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["type"],"type":"object","uniqueKey":"end_users.items.[INDEX].data_sources.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","uniqueKey":"end_users.items.[INDEX].data_sources","typeLabel":"object[]"},"files":{"items":{"properties":{"file_class":{"oneOf":[{"type":"string","uniqueKey":"end_users.items.[INDEX].files.items.[INDEX].file_class.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"end_users.items.[INDEX].files.items.[INDEX].file_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].files.items.[INDEX].file_class","typeLabel":"string | null"},"filename":{"type":"string","uniqueKey":"end_users.items.[INDEX].files.items.[INDEX].filename","typeLabel":"string"},"heron_id":{"type":"string","uniqueKey":"end_users.items.[INDEX].files.items.[INDEX].heron_id","typeLabel":"string"},"renamed_filename":{"oneOf":[{"type":"string","uniqueKey":"end_users.items.[INDEX].files.items.[INDEX].renamed_filename.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"end_users.items.[INDEX].files.items.[INDEX].renamed_filename.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].files.items.[INDEX].renamed_filename","typeLabel":"string | null"}},"type":"object","uniqueKey":"end_users.items.[INDEX].files.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"end_users.items.[INDEX].files","typeLabel":"object[]"},"heron_id":{"description":"Unique id for end user generated by Heron","example":"eus_9qQBmrBQMMUkek76UmiQ7m","readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].heron_id","typeLabel":"string"},"in_human_review":{"description":"Whether an active document is pending human review","readOnly":true,"type":"boolean","uniqueKey":"end_users.items.[INDEX].in_human_review","typeLabel":"boolean"},"is_portfolio":{"description":"Whether the end user is part of a lending portfolio","example":true,"type":"boolean","uniqueKey":"end_users.items.[INDEX].is_portfolio","typeLabel":"boolean"},"last_processed_at":{"oneOf":[{"description":"When the end user was last successfully processed in Heron system","example":"2026-02-26T09:30:00+00:00","format":"date-time","readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].last_processed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the end user was last successfully processed in Heron system","example":"2026-02-26T09:30:00+00:00","format":"date-time","readOnly":true,"type":"null","uniqueKey":"end_users.items.[INDEX].last_processed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].last_processed_at","typeLabel":"string\u003cdate-time> | null"},"last_updated":{"description":"When the end user was last updated in Heron system","example":"2026-02-26T09:30:00+00:00","format":"date-time","readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].last_updated","typeLabel":"string\u003cdate-time>"},"lendsaas_deal_ids":{"description":"LendSaaS deal IDs linked to this end user. Absent unless include_lendsaas_deal_ids is requested.","items":{"type":"string","uniqueKey":"end_users.items.[INDEX].lendsaas_deal_ids.items.[INDEX]","typeLabel":"string"},"readOnly":true,"type":"array","uniqueKey":"end_users.items.[INDEX].lendsaas_deal_ids","typeLabel":"string[]"},"name":{"oneOf":[{"description":"Name of end user; may help to improve categorisation accuracy","example":"Company Name Inc.","maxLength":128,"type":"string","uniqueKey":"end_users.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"description":"Name of end user; may help to improve categorisation accuracy","example":"Company Name Inc.","maxLength":128,"type":"null","uniqueKey":"end_users.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].name","typeLabel":"string | null"},"policy_evaluation_results":{"description":"One entry per use_case, carrying the latest evaluation's policy identity and result","items":{"properties":{"policy_heron_id":{"description":"Heron ID of the policy that was evaluated","type":"string","uniqueKey":"end_users.items.[INDEX].policy_evaluation_results.items.[INDEX].policy_heron_id","typeLabel":"string"},"policy_name":{"description":"Name of the policy that was evaluated","type":"string","uniqueKey":"end_users.items.[INDEX].policy_evaluation_results.items.[INDEX].policy_name","typeLabel":"string"},"result":{"description":"Result of the policy evaluation","enum":["passed","failed","review_required","missing_data","execution_error","skipped"],"type":"string","uniqueKey":"end_users.items.[INDEX].policy_evaluation_results.items.[INDEX].result","typeLabel":"enum\u003cstring>"},"use_case":{"oneOf":[{"description":"Use case of the policy; null only for evaluations predating the backfill","enum":["background_check","cashflow",null],"uniqueKey":"end_users.items.[INDEX].policy_evaluation_results.items.[INDEX].use_case.oneOf.0","typeLabel":"any"},{"description":"Use case of the policy; null only for evaluations predating the backfill","enum":["background_check","cashflow",null],"type":"null","uniqueKey":"end_users.items.[INDEX].policy_evaluation_results.items.[INDEX].use_case.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].policy_evaluation_results.items.[INDEX].use_case","typeLabel":"any | null"}},"type":"object","uniqueKey":"end_users.items.[INDEX].policy_evaluation_results.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"end_users.items.[INDEX].policy_evaluation_results","typeLabel":"object[]"},"policy_evaluations":{"items":{"enum":["passed","failed","review_required","missing_data","execution_error","skipped"],"type":"string","uniqueKey":"end_users.items.[INDEX].policy_evaluations.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"end_users.items.[INDEX].policy_evaluations","typeLabel":"enum\u003cstring>[]"},"profit_and_loss_layout":{"oneOf":[{},{"type":"null","uniqueKey":"end_users.items.[INDEX].profit_and_loss_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].profit_and_loss_layout","typeLabel":"null"},"status":{"description":"Status of end user; 'ready' triggers async processing, 'review_requested' triggers manual review request","enum":["new","ready","processed","reviewed","review_requested","failed"],"example":"ready","type":"string","uniqueKey":"end_users.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"submitting_brokers":{"description":"Brokers who submitted this deal — the discriminator between same-named merchants. Absent unless include_submitting_brokers is requested.","items":{"additionalProperties":false,"properties":{"company":{"oneOf":[{"readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX].company.oneOf.0","typeLabel":"string"},{"readOnly":true,"type":"null","uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX].company.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX].company","typeLabel":"string | null"},"domain":{"oneOf":[{"readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"readOnly":true,"type":"null","uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX].domain","typeLabel":"string | null"},"email":{"oneOf":[{"readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"readOnly":true,"type":"null","uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX].email","typeLabel":"string | null"}},"type":"object","uniqueKey":"end_users.items.[INDEX].submitting_brokers.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","uniqueKey":"end_users.items.[INDEX].submitting_brokers","typeLabel":"object[]"},"tags":{"description":"Tags currently applied to this end user, read-only. Absent unless the endpoint returns them.","items":{"properties":{"name":{"description":"Identifier normalized to lowercase: alphanumeric plus '_', '-', ':', up to 140 chars. Unique to your account (case-insensitive).","type":"string","isRequired":true,"uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX].name","typeLabel":"string"},"color":{"oneOf":[{"description":"Optional display color as a six-digit hex code such as #1a2b3c, normalized to lowercase.","type":"string","uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"description":"Optional display color as a six-digit hex code such as #1a2b3c, normalized to lowercase.","type":"null","uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX].color","typeLabel":"string | null"},"description":{"oneOf":[{"description":"Optional human-readable description of the tag.","type":"string","uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional human-readable description of the tag.","type":"null","uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX].description","typeLabel":"string | null"},"heron_id":{"description":"Unique identifier for the tag","readOnly":true,"type":"string","uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX].heron_id","typeLabel":"string"},"is_system_managed":{"description":"Whether the tag is managed by Heron and cannot be changed through the tag API.","readOnly":true,"type":"boolean","uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX].is_system_managed","typeLabel":"boolean"}},"required":["name"],"type":"object","uniqueKey":"end_users.items.[INDEX].tags.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","uniqueKey":"end_users.items.[INDEX].tags","typeLabel":"object[]"}},"required":["end_user_id"],"type":"object","uniqueKey":"end_users.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"end_users","typeLabel":"object[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_meta":{"next_url":"\u003cstring>","num_results":123,"page":123,"pages":123,"per_page":123,"prev_url":"\u003cstring>","total":123},"end_users":[{"end_user_id":"7cb48787-6d91-5b9f-bc60-f30298ea5736","confidence":0.42,"created":"2026-02-26T09:30:00+00:00","criteria":[{"context":"higher_is_better","currency":"\u003cstring>","date_range":"last_180_days","description":"The number of unique transactions with a timestamp","group":"data_quality","label":"unique_transactions","status":"not_available","unit":"n","value":42.42}],"crm_queue":{"crm_integration_heron_id":"\u003cstring>","node_id":"\u003cstring>","status_id":"\u003cstring>","status_name":"\u003cstring>"},"crm_sync_result":{"crm_record_url":"\u003cstring>","error_message":"\u003cstring>","heron_id":"\u003cstring>","name":"\u003cstring>","occurred_at":"2023-11-07T05:31:56Z","provider":"\u003cstring>","result":"success","success_message":"\u003cstring>"},"data_sources":[{"type":"pdf","status":"new"}],"files":[{"file_class":"\u003cstring>","filename":"\u003cstring>","heron_id":"\u003cstring>","renamed_filename":"\u003cstring>"}],"heron_id":"eus_9qQBmrBQMMUkek76UmiQ7m","in_human_review":true,"is_portfolio":true,"last_processed_at":"2026-02-26T09:30:00+00:00","last_updated":"2026-02-26T09:30:00+00:00","lendsaas_deal_ids":["\u003cstring>"],"name":"Company Name Inc.","policy_evaluation_results":[{"policy_heron_id":"\u003cstring>","policy_name":"\u003cstring>","result":"passed","use_case":"background_check"}],"policy_evaluations":["passed"],"profit_and_loss_layout":"\u003cunknown>","status":"ready","submitting_brokers":[{"company":"\u003cstring>","domain":"\u003cstring>","email":"\u003cstring>"}],"tags":[{"name":"\u003cstring>","color":"\u003cstring>","description":"\u003cstring>","heron_id":"\u003cstring>","is_system_managed":true}]}]}}},"exampleType":"generated"}},"description":"OK","exampleType":"generated"}},"security":{"71e9a0b0-e11a-4bfb-8f9e-b2f3c68b4137":{"ApiKeyAuth":{"in":"header","name":"x-api-key","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"4e631a23-aace-4608-8544-b52193510c5d":{"description":"Production","url":"https://app.herondata.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"x-api-key","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://app.herondata.io/swagger"},"subdomain":"herondata","siteName":"Heron","title":"List EndUsers with Summary Information - Heron","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T00:16:56.051Z","originalFileLocation":"api-reference/endusers/list-endusers-with-summary-information.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get a list of EndUsers\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heron\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List EndUsers with Summary Information - Heron\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a list of EndUsers\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heron\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://herondata.mintlify.site/_mintlify/api/og/v2?division=EndUsers\u0026amp;title=List+EndUsers+with+Summary+Information\u0026amp;description=Get+a+list+of+EndUsers\u0026amp;theme=ab84809e928afe7af7489d3d\u0026amp;signature=a71546c80cb139af8a5bb948968a8d4b7018b797be4d58facc1da79892dbedb7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List EndUsers with Summary Information - Heron\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a list of EndUsers\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://herondata.mintlify.site/_mintlify/api/og/v2?division=EndUsers\u0026amp;title=List+EndUsers+with+Summary+Information\u0026amp;description=Get+a+list+of+EndUsers\u0026amp;theme=ab84809e928afe7af7489d3d\u0026amp;signature=a71546c80cb139af8a5bb948968a8d4b7018b797be4d58facc1da79892dbedb7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heron\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#CD461D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endusers/list-endusers-with-summary-information.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.herondata.io/#organization\",\"name\":\"Heron\",\"url\":\"https://docs.herondata.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/herondata/AkuG3WZNjPMLrlAs/logo/light.svg?fit=max\u0026auto=format\u0026n=AkuG3WZNjPMLrlAs\u0026q=85\u0026s=3fdaeef2943a89b32ca67895d004d0b9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.herondata.io#website\",\"name\":\"Heron\",\"url\":\"https://docs.herondata.io\",\"publisher\":{\"@id\":\"https://docs.herondata.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information#webpage\",\"url\":\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information\",\"name\":\"List EndUsers with Summary Information\",\"description\":\"Get a list of EndUsers\",\"dateModified\":\"2026-11-21T00:16:56.051Z\",\"isPartOf\":{\"@id\":\"https://docs.herondata.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"EndUsers\",\"item\":\"https://docs.herondata.io/api-reference/endusers/get-enduser-emails\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List EndUsers with Summary Information\",\"item\":\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information#apireference\",\"headline\":\"List EndUsers with Summary Information\",\"name\":\"List EndUsers with Summary Information\",\"description\":\"Get a list of EndUsers\",\"url\":\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information\",\"mainEntityOfPage\":{\"@id\":\"https://docs.herondata.io/api-reference/endusers/list-endusers-with-summary-information#webpage\"},\"dateModified\":\"2026-11-21T00:16:56.051Z\",\"publisher\":{\"@id\":\"https://docs.herondata.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.herondata.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heron\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Heron\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endusers/list-endusers-with-summary-information.md","siteName":"Heron","nav":{"global":{"anchors":[{"anchor":"Heron","icon":"house","href":"https://herondata.io"},{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.herondata.io"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/get-started/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Testing","pages":[{"title":"Get apihello world","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/hello_world","href":"/api-reference/testing/get-apihello_world"},{"title":"Get apihello worldauthenticated","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/hello_world/authenticated","href":"/api-reference/testing/get-apihello_worldauthenticated"}]},{"group":"MCP","pages":[]},{"group":"Analytics","pages":[{"title":"Get decline analytics for a user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/analytics/decline","href":"/api-reference/analytics/get-decline-analytics-for-a-user"}]},{"group":"AppStore","pages":[{"title":"List available apps","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/app_store/list","href":"/api-reference/appstore/list-available-apps"}]},{"group":"Authentication","pages":[]},{"group":"Brokers","pages":[{"title":"List broker EndUsers with deal summary information","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/summary","href":"/api-reference/brokers/list-broker-endusers-with-deal-summary-information"},{"title":"Get broker EndUser detail","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/{end_user_id_or_heron_id}","href":"/api-reference/brokers/get-broker-enduser-detail"},{"title":"Link a broker decision record to a deal; its live decisions move onto that deal's submissions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker/end_users/{end_user_id_or_heron_id}/deal_link/","href":"/api-reference/brokers/link-a-broker-decision-record-to-a-deal;-its-live-decisions-move-onto-that-deals-submissions"},{"title":"Dismiss a broker decision from deal-link review","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker/end_users/{end_user_id_or_heron_id}/deal_link/dismiss","href":"/api-reference/brokers/dismiss-a-broker-decision-from-deal-link-review"},{"title":"List deal-link candidates for a broker decision","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/{end_user_id_or_heron_id}/deal_link_candidates/","href":"/api-reference/brokers/list-deal-link-candidates-for-a-broker-decision"},{"title":"Set a broker deal's outcome","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/broker/end_users/{end_user_id_or_heron_id}/outcome","href":"/api-reference/brokers/set-a-broker-deals-outcome"},{"title":"Clear a broker deal's outcome","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/broker/end_users/{end_user_id_or_heron_id}/outcome","href":"/api-reference/brokers/clear-a-broker-deals-outcome"}]},{"group":"API Reference","pages":[{"title":"List funder submissions with their current decision and offers","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/{end_user_heron_id}/funder_submissions/","href":"/api-reference/list-funder-submissions-with-their-current-decision-and-offers"},{"title":"Validate an end user for configured funders","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/{end_user_heron_id}/funder_submissions/preflight/","href":"/api-reference/validate-an-end-user-for-configured-funders"},{"title":"Submit an end user to multiple funders","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker/end_users/{end_user_heron_id}/funder_submissions/submit_to_funders/","href":"/api-reference/submit-an-end-user-to-multiple-funders"},{"title":"Resolve a held funder submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker/end_users/{end_user_heron_id}/funder_submissions/{submission_heron_id}/exclusion_resolution/","href":"/api-reference/resolve-a-held-funder-submission"},{"title":"List broker funder policies for current user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/","href":"/api-reference/list-broker-funder-policies-for-current-user"},{"title":"Bulk update broker funder policies","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/broker_funder_policies/","href":"/api-reference/bulk-update-broker-funder-policies"},{"title":"Export broker funder policies as Excel","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/export/","href":"/api-reference/export-broker-funder-policies-as-excel"},{"title":"Add a funder to broker's policies","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_funder_policies/funders/","href":"/api-reference/add-a-funder-to-brokers-policies"},{"title":"Remove a funder from broker's policies","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/broker_funder_policies/funders/{funder_heron_id}/","href":"/api-reference/remove-a-funder-from-brokers-policies"},{"title":"Upload funder policy file for parsing","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_funder_policies/upload/","href":"/api-reference/upload-funder-policy-file-for-parsing"},{"title":"Get policy upload job status","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/upload/status/","href":"/api-reference/get-policy-upload-job-status"},{"title":"Get specific policy upload job","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/upload/{job_heron_id}/","href":"/api-reference/get-specific-policy-upload-job"},{"title":"List pending funder matches for a job","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/upload/{job_heron_id}/pending/","href":"/api-reference/list-pending-funder-matches-for-a-job"},{"title":"Resolve a pending funder match","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_funder_policies/upload/{job_heron_id}/pending/{index}/resolve/","href":"/api-reference/resolve-a-pending-funder-match"},{"title":"Skip a pending funder match","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_funder_policies/upload/{job_heron_id}/pending/{index}/skip/","href":"/api-reference/skip-a-pending-funder-match"},{"title":"Get deal link entries for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/deal_link/","href":"/api-reference/get-deal-link-entries-for-an-end-user"},{"title":"List funder policy evaluations for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/funder_policy_evaluations/","href":"/api-reference/list-funder-policy-evaluations-for-an-end-user"},{"title":"Submit an end user to a single funder","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/funder_submissions/{submission_heron_id}/submit_to_funder/","href":"/api-reference/submit-an-end-user-to-a-single-funder"},{"title":"List funder exclusion rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funder_exclusion_rules/","href":"/api-reference/list-funder-exclusion-rules"},{"title":"Add sender matchers to many funder exclusion rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_exclusion_rules/bulk/","href":"/api-reference/add-sender-matchers-to-many-funder-exclusion-rules"},{"title":"Delete many funder exclusion rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/funder_exclusion_rules/bulk/","href":"/api-reference/delete-many-funder-exclusion-rules"},{"title":"Add and remove sender matchers across many funder exclusion rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/funder_exclusion_rules/bulk/","href":"/api-reference/add-and-remove-sender-matchers-across-many-funder-exclusion-rules"},{"title":"Create or replace a funder exclusion rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/funder_exclusion_rules/{funder_heron_id}/","href":"/api-reference/create-or-replace-a-funder-exclusion-rule"},{"title":"Delete a funder exclusion rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/funder_exclusion_rules/{funder_heron_id}/","href":"/api-reference/delete-a-funder-exclusion-rule"},{"title":"List funder integration states for the current broker","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funder_integrations/","href":"/api-reference/list-funder-integration-states-for-the-current-broker"},{"title":"Link a funder to the current broker for self-service","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_integrations/","href":"/api-reference/link-a-funder-to-the-current-broker-for-self-service"},{"title":"List funders available for self-service that the broker hasn't linked yet","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funder_integrations/candidates/","href":"/api-reference/list-funders-available-for-self-service-that-the-broker-hasnt-linked-yet"},{"title":"Save staging or production form values for a funder integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/funder_integrations/{funder_heron_id}/","href":"/api-reference/save-staging-or-production-form-values-for-a-funder-integration"},{"title":"Remove a funder, or delete one environment's saved integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/funder_integrations/{funder_heron_id}/","href":"/api-reference/remove-a-funder-or-delete-one-environments-saved-integration"},{"title":"Update a funder's submission channel and email configuration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/funder_integrations/{funder_heron_id}/","href":"/api-reference/update-a-funders-submission-channel-and-email-configuration"},{"title":"Trigger a staging or production test submission for this funder","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_integrations/{funder_heron_id}/test/","href":"/api-reference/trigger-a-staging-or-production-test-submission-for-this-funder"},{"title":"Upsert a funder submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_submissions/","href":"/api-reference/upsert-a-funder-submission"},{"title":"Get funder submission status","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funder_submissions/{submission_heron_id}/","href":"/api-reference/get-funder-submission-status"},{"title":"Trigger a funder submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_submissions/{submission_heron_id}/trigger/","href":"/api-reference/trigger-a-funder-submission"},{"title":"Search funders by name","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funders/search/","href":"/api-reference/search-funders-by-name"},{"title":"Ingest end user data from a CRM webhook","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/ingestion/crm/{crm_integration_heron_id}","href":"/api-reference/ingest-end-user-data-from-a-crm-webhook"}]},{"group":"BrokerSubmissions","pages":[{"title":"Create broker submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_submissions/","href":"/api-reference/brokersubmissions/create-broker-submission"},{"title":"List broker API keys for a given user.","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_submissions/api_keys","href":"/api-reference/brokersubmissions/list-broker-api-keys-for-a-given-user"},{"title":"Generate broker API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_submissions/api_keys/generate","href":"/api-reference/brokersubmissions/generate-broker-api-key"},{"title":"Delete broker API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/broker_submissions/api_keys/{broker_funder_api_key_heron_id}","href":"/api-reference/brokersubmissions/delete-broker-api-key"},{"title":"Upload PDF files for broker submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_submissions/{submission_heron_id}/files","href":"/api-reference/brokersubmissions/upload-pdf-files-for-broker-submission"},{"title":"Add details to broker submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_submissions/{submission_heron_id}/update_information","href":"/api-reference/brokersubmissions/add-details-to-broker-submission"}]},{"group":"Categories","pages":[{"title":"Get categories","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/categories","href":"/api-reference/categories/get-categories"}]},{"group":"Policy","pages":[{"title":"List company attributes available for policy checks","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/company_attributes","href":"/api-reference/policy/list-company-attributes-available-for-policy-checks"},{"title":"Get the policy evaluations for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/policy_evaluations","href":"/api-reference/policy/get-the-policy-evaluations-for-an-end-user"},{"title":"Get all policy definitions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/policies","href":"/api-reference/policy/get-all-policy-definitions"},{"title":"Progress policies for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/policies/progress","href":"/api-reference/policy/progress-policies-for-an-end-user"}]},{"group":"Credentials","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/credentials/keys","href":"/api-reference/credentials/list-api-keys"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/credentials/keys/{heron_id}","href":"/api-reference/credentials/delete-an-api-key"},{"title":"Deactivate an API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/credentials/keys/{heron_id}/deactivate","href":"/api-reference/credentials/deactivate-an-api-key"}]},{"group":"CrmIntegrations","pages":[{"title":"List CRM Integrations","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/crm_integrations","href":"/api-reference/crmintegrations/list-crm-integrations"},{"title":"Create a CRM integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/crm_integrations","href":"/api-reference/crmintegrations/create-a-crm-integration"},{"title":"Patch a CRM integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/crm_integrations/{heron_id}","href":"/api-reference/crmintegrations/patch-a-crm-integration"}]},{"group":"EndUserDataSourceAccounts","pages":[{"title":"Update a data source account's account number","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/data_source_accounts/{dsa_heron_id_to_update}/update_number","href":"/api-reference/enduserdatasourceaccounts/update-a-data-source-accounts-account-number"},{"title":"Update a data source account","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/data_source_accounts/{heron_id}","href":"/api-reference/enduserdatasourceaccounts/update-a-data-source-account"},{"title":"Disable duplicate data source accounts for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/data_source_accounts/disable_duplicates","href":"/api-reference/enduserdatasourceaccounts/disable-duplicate-data-source-accounts-for-an-end-user"}]},{"group":"EndUserDataSources","pages":[{"title":"Update a data source","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/data_sources/{heron_id}","href":"/api-reference/enduserdatasources/update-a-data-source"},{"title":"Get data source account summary","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/data_source_account_summary","href":"/api-reference/enduserdatasources/get-data-source-account-summary"},{"title":"Get data sources","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/data_sources","href":"/api-reference/enduserdatasources/get-data-sources"},{"title":"Get paginated data source summaries","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/data_sources/summary","href":"/api-reference/enduserdatasources/get-paginated-data-source-summaries"}]},{"group":"EmailTemplates","pages":[{"title":"Get email templates","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/email_templates","href":"/api-reference/emailtemplates/get-email-templates"},{"title":"Create an email template","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/email_templates","href":"/api-reference/emailtemplates/create-an-email-template"},{"title":"Patch an email template","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/email_templates/{heron_id}","href":"/api-reference/emailtemplates/patch-an-email-template"}]},{"group":"EndUsers","pages":[{"title":"Get EndUser emails","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_emails","href":"/api-reference/endusers/get-enduser-emails"},{"title":"List EndUsers","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users","href":"/api-reference/endusers/list-endusers"},{"title":"Update EndUser","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/end_users","href":"/api-reference/endusers/update-enduser"},{"title":"Create EndUser","description":"Create a new end user. If transactions have previously been sent for this `end_user_id`, use `PUT end_users` to update instead.\n","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users","href":"/api-reference/endusers/create-enduser"},{"title":"List EndUsers with Summary Information","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/summary","href":"/api-reference/endusers/list-endusers-with-summary-information"},{"title":"Get EndUser background check dashboard payload","description":"Get the background check results for an end user, including the screening run status, each subject's identity matches and records, and the outcome of each policy check.\n","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check","href":"/api-reference/endusers/get-enduser-background-check-dashboard-payload"},{"title":"List an end user's background check affiliations","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/affiliations","href":"/api-reference/endusers/list-an-end-users-background-check-affiliations"},{"title":"Request background check reports for affiliations","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/background_check/affiliations/reports","href":"/api-reference/endusers/request-background-check-reports-for-affiliations"},{"title":"Confirm a candidate for an affiliate report","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/background_check/affiliations/reports/confirm","href":"/api-reference/endusers/confirm-a-candidate-for-an-affiliate-report"},{"title":"Stop tracking an affiliate report","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_users/{end_user_heron_id}/background_check/affiliations/reports/{ref}","href":"/api-reference/endusers/stop-tracking-an-affiliate-report"},{"title":"Get the pinned CLEAR candidate overrides for a background check","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/override","href":"/api-reference/endusers/get-the-pinned-clear-candidate-overrides-for-a-background-check"},{"title":"Pin CLEAR candidate overrides for a background check","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/background_check/override","href":"/api-reference/endusers/pin-clear-candidate-overrides-for-a-background-check"},{"title":"Clear all CLEAR candidate overrides for a background check","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_users/{end_user_heron_id}/background_check/override","href":"/api-reference/endusers/clear-all-clear-candidate-overrides-for-a-background-check"},{"title":"Download the background check as a PDF","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/pdf","href":"/api-reference/endusers/download-the-background-check-as-a-pdf"},{"title":"Download a subject's background check as XML","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report","href":"/api-reference/endusers/download-a-subjects-background-check-as-xml"},{"title":"View a criminal-record mug shot","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/records/{record_id}/mugshot","href":"/api-reference/endusers/view-a-criminal-record-mug-shot"},{"title":"Get an end user's background check verification","deprecated":true,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/verification","href":"/api-reference/endusers/get-an-end-users-background-check-verification"},{"title":"Get the business and owner details of an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/details","href":"/api-reference/endusers/get-the-business-and-owner-details-of-an-end-user"},{"title":"Update the business and owner details of an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_users/{end_user_heron_id}/details","href":"/api-reference/endusers/update-the-business-and-owner-details-of-an-end-user"},{"title":"Get duplicate end users for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/duplicate_end_users","href":"/api-reference/endusers/get-duplicate-end-users-for-an-end-user"},{"title":"Get an end user's fraud network scan","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/fraud_detection/fraud_network","href":"/api-reference/endusers/get-an-end-users-fraud-network-scan"},{"title":"Get an end user's verification","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/verification","href":"/api-reference/endusers/get-an-end-users-verification"},{"title":"Get EndUser by heron_id or end_user_id","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}","href":"/api-reference/endusers/get-enduser-by-heron_id-or-end_user_id"},{"title":"Delete EndUser by heron_id or end_user_id (sync)","deprecated":true,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_users/{end_user_id_or_heron_id}","href":"/api-reference/endusers/delete-enduser-by-heron_id-or-end_user_id-sync"},{"title":"Delete EndUser by heron_id or end_user_id (async)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/delete","href":"/api-reference/endusers/delete-enduser-by-heron_id-or-end_user_id-async"},{"title":"Get EndUser emails","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/emails","href":"/api-reference/endusers/get-enduser-emails-1"},{"title":"Get EndUser information","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/end_user_information","href":"/api-reference/endusers/get-enduser-information"},{"title":"Patch EndUser information","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_users/{end_user_id_or_heron_id}/end_user_information","href":"/api-reference/endusers/patch-enduser-information"},{"title":"Enrich transactions of EndUser","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/enrich","href":"/api-reference/endusers/enrich-transactions-of-enduser"},{"title":"Get EndUser physical location","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/location","href":"/api-reference/endusers/get-enduser-physical-location"},{"title":"Get EndUser processing status","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/processing_status","href":"/api-reference/endusers/get-enduser-processing-status"},{"title":"Retrieve CRM sync events for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{heron_id}/crm_sync","href":"/api-reference/endusers/retrieve-crm-sync-events-for-an-end-user"},{"title":"Trigger a CRM Sync for an End User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{heron_id}/crm_sync","href":"/api-reference/endusers/trigger-a-crm-sync-for-an-end-user"}]},{"group":"EndUserEmails","pages":[{"title":"Export an end user email as an EML file","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_emails/{heron_id}/export","href":"/api-reference/enduseremails/export-an-end-user-email-as-an-eml-file"}]},{"group":"EndUserEnrichers","pages":[{"title":"Start enricher execution for a specific end user asynchronously","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_enrichers/definitions/{enricher_definition_name}/start_enrich","href":"/api-reference/enduserenrichers/start-enricher-execution-for-a-specific-end-user-asynchronously"},{"title":"Get all fields for all enrichers for a given user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_enrichers/fields","href":"/api-reference/enduserenrichers/get-all-fields-for-all-enrichers-for-a-given-user"},{"title":"Trigger enricher execution for a specific end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_enrichers/{end_user_heron_id}/enrich","href":"/api-reference/enduserenrichers/trigger-enricher-execution-for-a-specific-end-user"},{"title":"Get enrichment results for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_enrichers/{end_user_heron_id}/enricher_results","href":"/api-reference/enduserenrichers/get-enrichment-results-for-an-end-user"},{"title":"Get enricher result by enricher name and end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_enrichers/{end_user_heron_id}/enricher_results/{enricher_name}","href":"/api-reference/enduserenrichers/get-enricher-result-by-enricher-name-and-end-user"}]},{"group":"EndUserEntity","pages":[{"title":"Get the definitions for all end user entities","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_entities","href":"/api-reference/enduserentity/get-the-definitions-for-all-end-user-entities"},{"title":"Create an end user entity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_entities","href":"/api-reference/enduserentity/create-an-end-user-entity"},{"title":"Export all saved attribute for all end users to an Excel file","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_entities/attribute_values/export","href":"/api-reference/enduserentity/export-all-saved-attribute-for-all-end-users-to-an-excel-file"},{"title":"Set the display order of end user entities","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/reorder","href":"/api-reference/enduserentity/set-the-display-order-of-end-user-entities"},{"title":"Create an end user entity attribute","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_entities/{entity_heron_id}/attributes","href":"/api-reference/enduserentity/create-an-end-user-entity-attribute"},{"title":"Set the display order of end user entity attributes","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/{entity_heron_id}/attributes/reorder","href":"/api-reference/enduserentity/set-the-display-order-of-end-user-entity-attributes"},{"title":"Delete an EndUserEntityAttribute","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}","href":"/api-reference/enduserentity/delete-an-enduserentityattribute"},{"title":"Update an end user entity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}","href":"/api-reference/enduserentity/update-an-end-user-entity"},{"title":"Create an end user entity attribute","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/clone","href":"/api-reference/enduserentity/create-an-end-user-entity-attribute-1"},{"title":"Create an end user entity attribute source","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/sources","href":"/api-reference/enduserentity/create-an-end-user-entity-attribute-source"},{"title":"Delete an EndUserEntityAttribute","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/sources/{source_heron_id}","href":"/api-reference/enduserentity/delete-an-enduserentityattribute-1"},{"title":"Upsert an end user entity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/sources/{source_heron_id}","href":"/api-reference/enduserentity/upsert-an-end-user-entity"},{"title":"Delete an EndUserEntity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_user_entities/{heron_id}","href":"/api-reference/enduserentity/delete-an-enduserentity"},{"title":"Update an end user entity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/{heron_id}","href":"/api-reference/enduserentity/update-an-end-user-entity-1"},{"title":"Get the materialised end user entities for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/entities","href":"/api-reference/enduserentity/get-the-materialised-end-user-entities-for-an-end-user"},{"title":"Bulk save entity attribute values by entity name and attribute name","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/end_users/{end_user_heron_id}/entities/values/bulk","href":"/api-reference/enduserentity/bulk-save-entity-attribute-values-by-entity-name-and-attribute-name"},{"title":"Upsert the attribute value for an end user entity attribute source","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/entities/{entity_heron_id}","href":"/api-reference/enduserentity/upsert-the-attribute-value-for-an-end-user-entity-attribute-source"}]},{"group":"EndUserFiles","pages":[{"title":"All EndUserFiles","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files","href":"/api-reference/enduserfiles/all-enduserfiles"},{"title":"List flagged bank statements","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/alteration_flags","href":"/api-reference/enduserfiles/list-flagged-bank-statements"},{"title":"Process file without creating EndUserFile record","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/process_standalone","href":"/api-reference/enduserfiles/process-file-without-creating-enduserfile-record"},{"title":"Get recent files by file class","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/recent_by_file_class","href":"/api-reference/enduserfiles/get-recent-files-by-file-class"},{"title":"Get file rename rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/rename_rules","href":"/api-reference/enduserfiles/get-file-rename-rules"},{"title":"Create a file rename rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/rename_rules","href":"/api-reference/enduserfiles/create-a-file-rename-rule"},{"title":"Get file rename rule variable slugs","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/rename_rules/slugs","href":"/api-reference/enduserfiles/get-file-rename-rule-variable-slugs"},{"title":"Update a file rename rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_files/rename_rules/{heron_id}","href":"/api-reference/enduserfiles/update-a-file-rename-rule"},{"title":"Get a single end user file by Heron ID","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/{heron_id}","href":"/api-reference/enduserfiles/get-a-single-end-user-file-by-heron-id"},{"title":"Delete an EndUserFile","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_user_files/{heron_id}","href":"/api-reference/enduserfiles/delete-an-enduserfile"},{"title":"Update the end user file's class","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_files/{heron_id}","href":"/api-reference/enduserfiles/update-the-end-user-files-class"},{"title":"Get EndUserFile as a base64 string","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/{heron_id}/file","href":"/api-reference/enduserfiles/get-enduserfile-as-a-base64-string"},{"title":"Trigger async parsing of an end user file","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/{heron_id}/parse_file","href":"/api-reference/enduserfiles/trigger-async-parsing-of-an-end-user-file"},{"title":"Get parsed results from uploaded files","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/{heron_id}/parsed_results","href":"/api-reference/enduserfiles/get-parsed-results-from-uploaded-files"},{"title":"Trigger file's rename rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/{heron_id}/trigger_rename","href":"/api-reference/enduserfiles/trigger-files-rename-rule"},{"title":"Trigger splitting a combined end user file into its child files based on its page_classes","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/{heron_id}/trigger_split","href":"/api-reference/enduserfiles/trigger-splitting-a-combined-end-user-file-into-its-child-files-based-on-its-page_classes"},{"title":"Get EndUserFiles","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/files","href":"/api-reference/enduserfiles/get-enduserfiles"},{"title":"Post EndUserFile","deprecated":true,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/files","href":"/api-reference/enduserfiles/post-enduserfile"},{"title":"Download EndUserFiles","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/files/download","href":"/api-reference/enduserfiles/download-enduserfiles"},{"title":"Download xlsx of parsed results from uploaded files","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/files/parsed_results/xlsx","href":"/api-reference/enduserfiles/download-xlsx-of-parsed-results-from-uploaded-files"},{"title":"Get EndUserFile summaries","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/files/summary","href":"/api-reference/enduserfiles/get-enduserfile-summaries"},{"title":"Post EndUserFile V2","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/files/v2","href":"/api-reference/enduserfiles/post-enduserfile-v2"},{"title":"Start Workflow","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/start_workflow","href":"/api-reference/enduserfiles/start-workflow"}]},{"group":"FileClass","pages":[{"title":"Get all file classes","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/file_classes","href":"/api-reference/fileclass/get-all-file-classes"},{"title":"Get file class groups enabled for a User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/users/file_class_groups","href":"/api-reference/fileclass/get-file-class-groups-enabled-for-a-user"},{"title":"Get current file classes used in classification","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/users/file_classes","href":"/api-reference/fileclass/get-current-file-classes-used-in-classification"},{"title":"Add a FileClass to Classify for a User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/users/file_classes/{file_class_name}","href":"/api-reference/fileclass/add-a-fileclass-to-classify-for-a-user"},{"title":"Remove a FileClass from Classification for a User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/users/file_classes/{file_class_name}","href":"/api-reference/fileclass/remove-a-fileclass-from-classification-for-a-user"}]},{"group":"End User Files","pages":[]},{"group":"EndUserQueries","pages":[]},{"group":"EndUserCalculations","pages":[{"title":"Get EndUser balance","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/balance","href":"/api-reference/endusercalculations/get-enduser-balance"},{"title":"Get EndUser forecasts","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/forecast","href":"/api-reference/endusercalculations/get-enduser-forecasts"},{"title":"Get EndUser statistics","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/statistics","href":"/api-reference/endusercalculations/get-enduser-statistics"},{"title":"Get EndUser anomalies","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/anomalies","href":"/api-reference/endusercalculations/get-enduser-anomalies"},{"title":"Get EndUser bank statement summary","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/bank_statement_summary","href":"/api-reference/endusercalculations/get-enduser-bank-statement-summary"},{"title":"Get EndUser metric benchmarks","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/benchmarks","href":"/api-reference/endusercalculations/get-enduser-metric-benchmarks"},{"title":"Get EndUser debt candidates","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/debt_candidates","href":"/api-reference/endusercalculations/get-enduser-debt-candidates"},{"title":"Export as a spreadsheet","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/export_spreadsheet","href":"/api-reference/endusercalculations/export-as-a-spreadsheet"},{"title":"Get EndUser transactions grouped by counterparty or merchant","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/grouped_transactions_report","href":"/api-reference/endusercalculations/get-enduser-transactions-grouped-by-counterparty-or-merchant"},{"title":"Get EndUser Heron Score (beta)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/heron_score","href":"/api-reference/endusercalculations/get-enduser-heron-score-beta"},{"title":"Get EndUser merchant summary","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/merchant_summary","href":"/api-reference/endusercalculations/get-enduser-merchant-summary"},{"title":"Get EndUser named dates","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/named_dates","href":"/api-reference/endusercalculations/get-enduser-named-dates"},{"title":"Get EndUser cashflow P\u0026L","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/profit_and_loss","href":"/api-reference/endusercalculations/get-enduser-cashflow-p\u0026l"},{"title":"Update EndUser P\u0026L layout","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/end_users/{end_user_id_or_heron_id}/profit_and_loss_layout","href":"/api-reference/endusercalculations/update-enduser-p\u0026l-layout"},{"title":"Get EndUser recurring transactions report","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report","href":"/api-reference/endusercalculations/get-enduser-recurring-transactions-report"},{"title":"Get EndUser scorecard","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/scorecard","href":"/api-reference/endusercalculations/get-enduser-scorecard"},{"title":"Request EndUser scorecard","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/scorecard/async","href":"/api-reference/endusercalculations/request-enduser-scorecard"},{"title":"Get EndUser transaction data coverage","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/transaction_data_coverage","href":"/api-reference/endusercalculations/get-enduser-transaction-data-coverage"}]},{"group":"EndUserAttributes","pages":[{"title":"Get EndUser attribute values","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/company_attributes","href":"/api-reference/enduserattributes/get-enduser-attribute-values"}]},{"group":"EndUserAccounts","pages":[{"title":"Get Missing Accounts (beta)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/missing_accounts","href":"/api-reference/enduseraccounts/get-missing-accounts-beta"}]},{"group":"EnrichmentFeedback","pages":[{"title":"Bulk create category feedback for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/bulk_category_feedback","href":"/api-reference/enrichmentfeedback/bulk-create-category-feedback-for-an-end-user"},{"title":"Bulk create merchant feedback for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/merchant_feedback","href":"/api-reference/enrichmentfeedback/bulk-create-merchant-feedback-for-an-end-user"},{"title":"Revert merchant feedback for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/merchant_feedback/revert","href":"/api-reference/enrichmentfeedback/revert-merchant-feedback-for-an-end-user"},{"title":"Create category, merchant feedback","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/transactions/{heron_id}/feedback","href":"/api-reference/enrichmentfeedback/create-category-merchant-feedback"}]},{"group":"EndUserFinancials","pages":[{"title":"Get EndUser's combined financials","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/combined_financials","href":"/api-reference/enduserfinancials/get-endusers-combined-financials"}]},{"group":"EndUserIntegrations","pages":[{"title":"Upload DecisionLogic XML","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/decision_logic","href":"/api-reference/enduserintegrations/upload-decisionlogic-xml"},{"title":"Upload Inscribe","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/inscribe","href":"/api-reference/enduserintegrations/upload-inscribe"},{"title":"Get Integration Links","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/integration_links","href":"/api-reference/enduserintegrations/get-integration-links"},{"title":"Upload Ocrolus","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/ocrolus","href":"/api-reference/enduserintegrations/upload-ocrolus"},{"title":"Get PDFs","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/pdfs","href":"/api-reference/enduserintegrations/get-pdfs"},{"title":"Parse all PDF","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/pdfs/parse","href":"/api-reference/enduserintegrations/parse-all-pdf"},{"title":"Upload PDF","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/pdfs/v1","href":"/api-reference/enduserintegrations/upload-pdf"},{"title":"Upload Plaid assets","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/plaid/assets","href":"/api-reference/enduserintegrations/upload-plaid-assets"},{"title":"Upload Plaid transactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/plaid/transactions","href":"/api-reference/enduserintegrations/upload-plaid-transactions"},{"title":"Upload Yodlee","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/yodlee","href":"/api-reference/enduserintegrations/upload-yodlee"},{"title":"Get single PDF by heron_id","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/integrations/pdfs/{heron_id}","href":"/api-reference/enduserintegrations/get-single-pdf-by-heron_id"},{"title":"Update PDF attributes including status","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/integrations/pdfs/{heron_id}","href":"/api-reference/enduserintegrations/update-pdf-attributes-including-status"},{"title":"Send patch transactions for a pdf statement","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/integrations/pdfs/{heron_id}/processed","href":"/api-reference/enduserintegrations/send-patch-transactions-for-a-pdf-statement"},{"title":"Reloads transactions for a pdf","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/pdfs/{heron_id}/reload_transactions","href":"/api-reference/enduserintegrations/reloads-transactions-for-a-pdf"},{"title":"Unloads transactions for a pdf","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/pdfs/{heron_id}/unload_transactions","href":"/api-reference/enduserintegrations/unloads-transactions-for-a-pdf"},{"title":"Update PDF currency","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/pdfs/{heron_id}/update_currency","href":"/api-reference/enduserintegrations/update-pdf-currency"}]},{"group":"EndUserRules","pages":[{"title":"Evaluate all rules for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/evaluate_rules","href":"/api-reference/enduserrules/evaluate-all-rules-for-an-end-user"}]},{"group":"ISOApplication","pages":[{"title":"Upload an ISO application PDF for for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/iso_application_form","href":"/api-reference/isoapplication/upload-an-iso-application-pdf-for-for-an-end-user"},{"title":"Get EndUser ISO Applications","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/iso_applications","href":"/api-reference/isoapplication/get-enduser-iso-applications"},{"title":"Upload an ISO application PDF for automated scrubbing in under 15 seconds","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/iso_applications/","href":"/api-reference/isoapplication/upload-an-iso-application-pdf-for-automated-scrubbing-in-under-15-seconds"},{"title":"Upload an ISO application PDF for automated scrubbing in under 15 seconds (base64)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/iso_applications/base64","href":"/api-reference/isoapplication/upload-an-iso-application-pdf-for-automated-scrubbing-in-under-15-seconds-base64"},{"title":"Reprocess a single ISO application","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/iso_applications/reprocess/{heron_id}","href":"/api-reference/isoapplication/reprocess-a-single-iso-application"},{"title":"Get the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed \"iso_\")","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/iso_applications/{heron_id}","href":"/api-reference/isoapplication/get-the-scrubbed-results-and-data-validations-of-an-uploaded-iso-application-by-its-heron_id-prefixed-\"iso_\""}]},{"group":"Positions","pages":[{"title":"Get positions summary for end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/positions","href":"/api-reference/positions/get-positions-summary-for-end-user"},{"title":"Get edits that no longer apply","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/positions/stale_overrides","href":"/api-reference/positions/get-edits-that-no-longer-apply"},{"title":"Apply an edit that no longer applies to a rebuilt position","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/position_overrides/{override_heron_id}/reannotate","href":"/api-reference/positions/apply-an-edit-that-no-longer-applies-to-a-rebuilt-position"},{"title":"Get a position's edit history","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/positions/{position_heron_id}/overrides","href":"/api-reference/positions/get-a-positions-edit-history"},{"title":"Override a position's status, frequency or payment amount","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/positions/{position_heron_id}/overrides","href":"/api-reference/positions/override-a-positions-status-frequency-or-payment-amount"},{"title":"Remove a position's override","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/positions/{position_heron_id}/overrides","href":"/api-reference/positions/remove-a-positions-override"},{"title":"Get transactions for a specific position","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/positions/{position_heron_id}/transactions","href":"/api-reference/positions/get-transactions-for-a-specific-position"}]},{"group":"Tags","pages":[{"title":"List an end user's tags","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/tags","href":"/api-reference/tags/list-an-end-users-tags"},{"title":"Replace an end user's tags","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/end_users/{end_user_id_or_heron_id}/tags","href":"/api-reference/tags/replace-an-end-users-tags"},{"title":"Add tags to an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/tags","href":"/api-reference/tags/add-tags-to-an-end-user"},{"title":"Remove a tag from an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_users/{end_user_id_or_heron_id}/tags/{tag_heron_id}","href":"/api-reference/tags/remove-a-tag-from-an-end-user"},{"title":"List tags","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Get a tag","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/tags/{heron_id}","href":"/api-reference/tags/get-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/tags/{heron_id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/tags/{heron_id}","href":"/api-reference/tags/update-a-tag"}]},{"group":"EnrichedTransactions","pages":[{"title":"Get end user transactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/transactions","href":"/api-reference/enrichedtransactions/get-end-user-transactions"},{"title":"Get apitransactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/transactions/{reference_id_or_heron_id}","href":"/api-reference/enrichedtransactions/get-apitransactions"}]},{"group":"Transactions","pages":[{"title":"Create end user transactions (async)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/transactions","href":"/api-reference/transactions/create-end-user-transactions-async"},{"title":"Get apitransactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/transactions","href":"/api-reference/transactions/get-apitransactions"},{"title":"Enrich transactions (sync)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/transactions","href":"/api-reference/transactions/enrich-transactions-sync"},{"title":"Delete transactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/transactions","href":"/api-reference/transactions/delete-transactions"}]},{"group":"Funders","pages":[{"title":"Search funders by name","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funders/","href":"/api-reference/funders/search-funders-by-name"},{"title":"List your linked funders","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funders/linked","href":"/api-reference/funders/list-your-linked-funders"},{"title":"Get a single funder","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funders/{heron_id}","href":"/api-reference/funders/get-a-single-funder"}]},{"group":"Integrations","pages":[{"title":"Update an Integration Link","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/integration_links/{item_id}","href":"/api-reference/integrations/update-an-integration-link"},{"title":"List Integrations","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/integrations","href":"/api-reference/integrations/list-integrations"},{"title":"Create an integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations","href":"/api-reference/integrations/create-an-integration"},{"title":"Update Integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/integrations/{heron_id}","href":"/api-reference/integrations/update-integration"},{"title":"Get IntegrationLinks by Integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/integrations/{heron_id}/links","href":"/api-reference/integrations/get-integrationlinks-by-integration"},{"title":"Refresh assets reports for integration links","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/integrations/{heron_id}/links","href":"/api-reference/integrations/refresh-assets-reports-for-integration-links"},{"title":"Create an integration Link","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/{heron_id}/links","href":"/api-reference/integrations/create-an-integration-link"},{"title":"(Soft-)Delete an integration link","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/integrations/{heron_id}/links","href":"/api-reference/integrations/soft-delete-an-integration-link"},{"title":"Refresh an IntegrationLink","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/{heron_id}/links/{link_item_id}/refresh","href":"/api-reference/integrations/refresh-an-integrationlink"}]},{"group":"Interaction Logs","pages":[]},{"group":"MCP endpoints","pages":[]},{"group":"Merchants","pages":[{"title":"Extract merchant","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/merchants/extract","href":"/api-reference/merchants/extract-merchant"},{"title":"List merchant groups","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/merchants/groups","href":"/api-reference/merchants/list-merchant-groups"},{"title":"List merchants","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/merchants/list","href":"/api-reference/merchants/list-merchants"},{"title":"Search merchants","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/merchants/search","href":"/api-reference/merchants/search-merchants"},{"title":"Get merchant by ID","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/merchants/{heron_id}","href":"/api-reference/merchants/get-merchant-by-id"},{"title":"Set merchant group override","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/merchants/{merchant_heron_id}/user_merchant_group","href":"/api-reference/merchants/set-merchant-group-override"}]},{"group":"OAuth","pages":[]},{"group":"OneSchema","pages":[]},{"group":"Policy Versions","pages":[{"title":"List policy versions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/policy_version","href":"/api-reference/policy-versions/list-policy-versions"},{"title":"Create a draft policy version","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/policy_version","href":"/api-reference/policy-versions/create-a-draft-policy-version"},{"title":"Archive the draft policy version","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/policy_version/draft/archive","href":"/api-reference/policy-versions/archive-the-draft-policy-version"},{"title":"Create a draft policy version with new check values","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/policy_version/draft/check","href":"/api-reference/policy-versions/create-a-draft-policy-version-with-new-check-values"},{"title":"Update a lookup table in the draft","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/policy_version/draft/lookup_tables/{heron_id}","href":"/api-reference/policy-versions/update-a-lookup-table-in-the-draft"},{"title":"List the account's lookup tables","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/policy_version/lookup_tables","href":"/api-reference/policy-versions/list-the-accounts-lookup-tables"},{"title":"Publish the draft policy version","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/policy_version/publish","href":"/api-reference/policy-versions/publish-the-draft-policy-version"},{"title":"Preview publishing the draft","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/policy_version/publish/preview","href":"/api-reference/policy-versions/preview-publishing-the-draft"},{"title":"Get a policy version","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/policy_version/{version}","href":"/api-reference/policy-versions/get-a-policy-version"}]},{"group":"Policy Backtests","pages":[]},{"group":"Rules","pages":[{"title":"Get rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/rules/","href":"/api-reference/rules/get-rules"},{"title":"Create a single rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/rules/","href":"/api-reference/rules/create-a-single-rule"},{"title":"Get metrics","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/rules/metrics","href":"/api-reference/rules/get-metrics"},{"title":"Update rule by heron_id","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/rules/{heron_id}","href":"/api-reference/rules/update-rule-by-heron_id"},{"title":"Delete rule by heron_id","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/rules/{heron_id}","href":"/api-reference/rules/delete-rule-by-heron_id"}]},{"group":"ParsedEndUserSubmission","pages":[{"title":"Get parsed submissions for an End User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/submission_parsers/{end_user_heron_id}","href":"/api-reference/parsedendusersubmission/get-parsed-submissions-for-an-end-user"}]},{"group":"UserMerchantGroups","pages":[{"title":"This endpoint returns merchant groups categorized as pending, custom, or rejected.","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/user_merchant_groups","href":"/api-reference/usermerchantgroups/this-endpoint-returns-merchant-groups-categorized-as-pending-custom-or-rejected"}]},{"group":"Users","pages":[{"title":"Get user's company overview layout","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/users/company_overview_layout","href":"/api-reference/users/get-users-company-overview-layout"},{"title":"Save user's company overview layout","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/users/company_overview_layout","href":"/api-reference/users/save-users-company-overview-layout"},{"title":"Save user's settings","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/users/current/settings","href":"/api-reference/users/save-users-settings"},{"title":"Rotate the webhook signing secret","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/users/secret/rotate","href":"/api-reference/users/rotate-the-webhook-signing-secret"}]},{"group":"Watermarks","pages":[{"title":"Retrieve user logo","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/watermarks/logo","href":"/api-reference/watermarks/retrieve-user-logo"},{"title":"Upload user logo","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/watermarks/logo","href":"/api-reference/watermarks/upload-user-logo"}]},{"group":"Webhooks","pages":[{"title":"Get webhooks","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/webhooks","href":"/api-reference/webhooks/get-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"List webhook delivery attempts","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/webhooks/deliveries","href":"/api-reference/webhooks/list-webhook-delivery-attempts"},{"title":"Resend failed webhook deliveries","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/webhooks/deliveries/resend","href":"/api-reference/webhooks/resend-failed-webhook-deliveries"},{"title":"Get a webhook delivery attempt","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/webhooks/deliveries/{heron_id}","href":"/api-reference/webhooks/get-a-webhook-delivery-attempt"},{"title":"Get webhook topics","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/webhooks/topics","href":"/api-reference/webhooks/get-webhook-topics"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/webhooks/{heron_id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/webhooks/{heron_id}","href":"/api-reference/webhooks/delete-a-webhook"}]},{"group":"Workflows","pages":[{"title":"Start a workflow by Heron ID for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/workflow/start_by_heron_id","href":"/api-reference/workflows/start-a-workflow-by-heron-id-for-an-end-user"},{"title":"Start a workflow by name for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/workflow/start_by_name","href":"/api-reference/workflows/start-a-workflow-by-name-for-an-end-user"},{"title":"List workflows for the current user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/workflow/user/workflows","href":"/api-reference/workflows/list-workflows-for-the-current-user"}]}]}]},"basePath":"","title":"List EndUsers with Summary Information - Heron","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}