--- title: "List broker EndUsers with deal summary information" method: GET path: "/api/broker/end_users/summary" tags: ["Brokers"] --- # List broker EndUsers with deal summary information `GET /api/broker/end_users/summary` ## Request - Base URL: `https://app.herondata.io` - URL: `https://app.herondata.io/api/broker/end_users/summary` - Auth: API key in header `x-api-key` Get the broker deal list. Broker customers only; responds 404 for others. ## Query parameters - `name` string, nullable - `status` 'new' | 'ready' | 'processed' | 'reviewed' | 'review_requested' | 'failed' | 'null', nullable - `is_portfolio` boolean, nullable - `order_by` 'last_updated_desc' | 'last_updated_asc' | 'created_desc' | 'created_asc' | 'latest_activity_desc' - `heron_id` string, nullable - `end_user_id` string, nullable - `tags` string[], nullable - `page` integer, nullable - `limit` integer, nullable - `include_data_sources` boolean - `include_scorecard_metrics` boolean - `include_tags` boolean - `with_policy_result` unknown - `with_crm_sync_result` unknown - `in_human_review` boolean, nullable - `include_submitting_brokers` boolean - `lendsaas_deal_ids` string[], nullable - `include_lendsaas_deal_ids` boolean - `include_crm_queue` boolean - `interval_start` string, date-time, nullable - `interval_end` string, date-time, nullable - `include_updates_in_interval` boolean - `broker_classification` unknown - `deal_stage` unknown - `broker_link_status` unknown - `holds_decision` boolean, nullable - `funder_heron_id` string, nullable - `include_decision_counts` boolean ## Response `200` OK - object - `_meta` Pagination - `next_url` string, url, nullable: the URL of the next page - `num_results` integer: the number of results on this page - `page` integer: current page - `pages` integer: the number of pages - `per_page` integer: the max number of results per page - `prev_url` string, url, nullable: the URL of the last page - `total` integer: the number of results across all pages - `end_users` BrokerEndUserSummary[] - `broker_link_status` unknown - `classification` 'submission' | 'decision' | 'other': How broker intake classified this end user's email thread. - `confidence` number: Aggregated confidence for the end user across all transactions; between 0 and 1 - `created` string, date-time: When the end user was created in Heron system - `criteria` Metric[]: List of scorecard metrics - `context` 'higher_is_better' | 'lower_is_better' | 'null', nullable: Context for how to interpret the metric, e.g., whether a higher value is 'better' than a lower value - `currency` string, nullable: The ISO currency code for metric, where applicable - `date_range` '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': Metric date range - `description` string, nullable: Description of metric - `group` 'data_quality' | 'processing_quality' | 'balance' | 'profit_and_loss' | 'debt' | 'risk_flag' | 'forecast' | 'heron' | 'ml_feature': The type of metric - `label` string: Metric label, slugified - `status` 'available' | 'partially_available' | 'not_available' | 'null', nullable: either 'calculated' or 'not_available' depending on the requested date range vs. date range of the data - `unit` 'n' | 'day' | 'ratio' | 'amount' | 'weekday' | 'array' | 'probability': The unit of measurement for metric - `value` unknown - `crm_sync_result` CrmSyncEvent - `crm_record_url` string, nullable - `error_message` string, nullable - `heron_id` string - `name` string - `occurred_at` string, date-time - `provider` string, nullable - `result` 'success' | 'failure' | 'no_sync_attempted' - `success_message` string, nullable - `data_sources` DataSource[]: List of data source summaries for the end user - `status` 'new' | 'parsing' | 'parsed' | 'processed' | 'human_reviewing' | 'approved' | 'rejected' | 'failed' | 'transactions_loaded' | 'transactions_unloaded' | 'pending' | 'active' | 'syncing' | 'erroring' | 'sync_disabled' | 'deleted_in_plaid' | 'unknown': Status of the data source entity, where applicable (e.g. pdfs, integration links) - `type` 'api' | 'csv' | 'pdf' | 'integration_link' | 'legacy' | 'legacy_pdf' | 'legacy_integration_link', required: Data source type - `deal_stage` 'ready' | 'missing_docs' | 'shopped' | 'offers_in' | 'funded' | 'closed': Where this deal sits in the broker pipeline. - `decision_counts` BrokerDealDecisionCounts - `approved` integer - `declined` integer - `pending` integer - `duplicate_count` integer: Number of duplicate submission records hidden behind this deal. - `end_user_id` string, required: id defined by user; links to the end_user_id for transactions - `files` EndUserEndUserFile[] - `file_class` string, nullable - `filename` string - `heron_id` string - `renamed_filename` string - `funded_offer_heron_id` string, nullable - `heron_id` string: Unique id for end user generated by Heron - `in_human_review` boolean: Whether an active document is pending human review - `is_portfolio` boolean: Whether the end user is part of a lending portfolio - `last_processed_at` string, date-time: When the end user was last successfully processed in Heron system - `last_updated` string, date-time: When the end user was last updated in Heron system - `latest_activity_at` string, date-time, nullable: Latest creation, funder submission, or current decision timestamp. - `linked_deal_end_user_heron_id` string, nullable: Heron ID of the deal linked to this broker end user. - `linked_deal_name` string, nullable: Display name of the deal linked to this broker end user. - `name` string, nullable: Name of end user; may help to improve categorisation accuracy - `outcome` unknown - `outcome_at` string, date-time, nullable - `policy_evaluation_results` PolicyEvaluationResult[]: One entry per use_case, carrying the latest evaluation's policy identity and result - `policy_heron_id` string: Heron ID of the policy that was evaluated - `policy_name` string: Name of the policy that was evaluated - `result` 'passed' | 'failed' | 'review_required' | 'missing_data' | 'execution_error' | 'skipped': Result of the policy evaluation - `use_case` unknown - `policy_evaluations` string[] - `profit_and_loss_layout` unknown - `reason` string, nullable - `status` 'new' | 'ready' | 'processed' | 'reviewed' | 'review_requested' | 'failed': Status of end user; 'ready' triggers async processing, 'review_requested' triggers manual review request - `submitting_brokers` SubmittingBroker[]: Brokers who submitted this deal — the discriminator between same-named merchants. - `company` string, nullable - `domain` string, nullable - `email` string, nullable - `tags` TagSchema[]: Tags currently applied to this end user, read-only. Absent unless the endpoint returns them. - `color` string, nullable: Optional display color as a six-digit hex code such as #1a2b3c, normalized to lowercase. - `description` string, nullable: Optional human-readable description of the tag. - `heron_id` string: Unique identifier for the tag - `is_system_managed` boolean: Whether the tag is managed by Heron and cannot be changed through the tag API. - `name` string, required: Identifier normalized to lowercase: alphanumeric plus '_', '-', ':', up to 140 chars. Unique to your account (case-insensitive). ## Other responses - `404`: Not found ## Changes - **2026-11-03** `bd8008e49534`: 1 info - endpoint added [Operation history](https://skmtc.dev/herondata/apis/heron-data-api/changes/api/broker/end_users/summary/get.md) --- [API](https://skmtc.dev/herondata/apis/heron-data-api.md) - [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/herondata/apis/heron-data-api/revisions/1ec936e17fef?raw)