EndUsers
List EndUsers with Summary Information
Get a list of EndUsers
GET
Authorizations
Query Parameters
Order to return end users by
Available options:
last_updated_desc
, last_updated_asc
, created_desc
, created_asc
Whether the to include data sources for each end user
Example:
true
Filter by ID associated with end_user_id field in transactions
Example:
"your_end_user_id"
Available options:
success
, failure
Unique ID generated by Heron
Example:
"eus_2x7o8UWLgLCHYBbrQugHgi"
Filter by status of end user
Available options:
new
, ready
, processed
, reviewed
, review_requested
, failed
Example:
"reviewed"
Whether the end user is part of a lending portfolio
Example:
true
Filter by name associated with end user
Example:
"your_end_user_name"
Pagination page number (optional). If provided, 'limit' must also be provided.
Required range:
x >= 1
Whether to include scorecard metrics for each end user (under field criteria)
Example:
true
Available options:
passed
, failed
, missing_data
Pagination limit per page (optional). If provided, 'page' must also be provided.
Required range:
1 <= x <= 10000
Response
200 - application/json
OK
The response is of type object
.