Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUsers

List EndUsers

Get a list of EndUsers

get/api/end_users

Query parameters

heron_idstring nullable
Example:eus_EnmcKFFRowBJYvmwNE25kw

Unique ID generated by Heron

end_user_idstring nullable
Example:your_end_user_id

Filter by ID associated with end_user_id field in transactions

namestring nullable
Example:your_end_user_name

Filter by name associated with end user

status'new' | 'ready' | 'processed' | 'reviewed' | 'review_requested' | 'failed' | 'null' nullable
Example:reviewed

Filter by status of end user

pageinteger

Pagination page number

limitinteger

Pagination limit per page

order_by'last_updated_desc' | 'last_updated_asc' | 'created_desc' | 'created_asc'

Order to return end users by

is_portfolioboolean nullable
Example:true

Whether the end user is part of a lending portfolio

include_data_sourcesboolean
Example:true

Whether the to include data sources for each end user

include_scorecard_metricsboolean
Example:true

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

Response

OK

Example response

{
  "_meta": {
    "limit": 1000,
    "page": 1,
    "pages": 3,
    "total": 3500
  },
  "end_users": [
    {
      "confidence": 0.42,
      "created": "2026-06-11T19:53:47.159649",
      "criteria": [
        {
          "context": "higher_is_better",
          "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": 42.42
        }
      ],
      "data_sources": [
        {
          "status": "new",
          "type": "pdf"
        }
      ],
      "end_user_id": "1b856eb2-8510-47d9-9025-c1bd7eb5eae4",
      "heron_id": "eus_WAcrEUnGkmMjYoRJBRbpwc",
      "is_portfolio": true,
      "last_processed_at": "2026-07-23T19:53:47.159954",
      "last_updated": "2026-07-23T19:53:47.159683",
      "name": "Company Name Inc.",
      "status": "ready"
    }
  ]
}