GET
/
api
/
end_users
curl --request GET \
  --url https://app.herondata.io/api/end_users \
  --header 'x-api-key: <api-key>'
{
  "_meta": {
    "limit": 1000,
    "next_url": "<string>",
    "page": 1,
    "pages": 3,
    "prev_url": "<string>",
    "total": 3500
  },
  "end_users": [
    {
      "confidence": 0.42,
      "created": "2025-03-19T19:15:20.363128",
      "criteria": [
        {
          "context": "higher_is_better",
          "currency": "<string>",
          "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": "<any>"
        }
      ],
      "data_sources": [
        {
          "status": "new",
          "type": "pdf"
        }
      ],
      "end_user_id": "e5969dfd-160d-4d0f-8e71-a0c219cebd78",
      "heron_id": "eus_2PbzLP3BSwiWSCdeaKmSUT",
      "is_portfolio": true,
      "last_processed_at": "2025-04-30T19:15:20.363340",
      "last_updated": "2025-04-30T19:15:20.363156",
      "name": "Company Name Inc.",
      "profit_and_loss_layout": "<any>",
      "status": "ready"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer
default:1000

Pagination limit per page

Required range: 1 <= x <= 10000
​
page
integer
default:1

Pagination page number

Required range: x >= 1
​
status
enum<string> | null

Filter by status of end user

Available options:
new,
ready,
processed,
reviewed,
review_requested,
failed
Example:

"reviewed"

​
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
​
include_scorecard_metrics
boolean
default:false

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

Example:

true

​
name
string | null

Filter by name associated with end user

Example:

"your_end_user_name"

​
heron_id
string | null

Unique ID generated by Heron

Example:

"eus_Kqd2BD2xTTb9t3eHnxe9rn"

​
include_data_sources
boolean
default:false

Whether the to include data sources for each end user

Example:

true

​
end_user_id
string | null

Filter by ID associated with end_user_id field in transactions

Example:

"your_end_user_id"

​
is_portfolio
boolean | null

Whether the end user is part of a lending portfolio

Example:

true

Response

200 - application/json
OK

The response is of type object.