List broker EndUsers with deal summary information
Get the broker deal list. Broker customers only; responds 404 for others.
Authorizations
Query Parameters
Unique ID generated by Heron
"eus_ACmBPMRohD55tSzHmWnyyS"
Filter by ID associated with end_user_id field in transactions
"your_end_user_id"
Filter by name associated with end user
"your_end_user_name"
Filter by status of end user
new, ready, processed, reviewed, review_requested, failed, null "reviewed"
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.
Pagination page number (optional). If provided, 'limit' must also be provided.
x >= 1Pagination limit per page (optional). If provided, 'page' must also be provided.
1 <= x <= 10000Order to return broker end users by
last_updated_desc, last_updated_asc, created_desc, created_asc, latest_activity_desc Whether the end user is part of a lending portfolio
true
Whether the to include data sources for each end user
true
Whether to include scorecard metrics for each end user (under field criteria)
true
Whether to include the tags applied to each end user
true
passed, failed, review_required, missing_data, null success, failure, no_sync_attempted, null Filter by whether an active document is pending human review
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.
Filter by broker intake classification.
submission, decision, other, null Filter by broker deal stage.
ready, missing_docs, shopped, offers_in, null