GET
/
api
/
end_users

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
include_scorecard_metrics
boolean
default:
false

Whether to include scorecard metrics for each end user (under field criteria)

​
include_data_sources
boolean
default:
false

Whether the to include data sources for each end user

​
order_by
enum<string>
default:
last_updated_desc

Order to return end users by

Available options:
last_updated_desc,
last_updated_asc,
created_desc,
created_asc
​
name
string | null

Filter by name associated with end user

​
status
enum<string> | null

Filter by status of end user

Available options:
new,
ready,
processed,
reviewed,
review_requested,
failed
​
page
integer
default:
1

Pagination page number

Required range: x > 1
​
limit
integer
default:
1000

Pagination limit per page

Required range: 1 < x < 10000
​
end_user_id
string | null

Filter by ID associated with end_user_id field in transactions

​
is_portfolio
boolean | null

Whether the end user is part of a lending portfolio

​
heron_id
string | null

Unique ID generated by Heron

Response

200 - application/json
​
_meta
object
​
end_users
object[]

Was this page helpful?

Get EndUser emailsUpdate EndUser