Skip to main content
GET
/
api
/
end_users
/
summary
List EndUsers with Summary Information
curl --request GET \
  --url https://app.herondata.io/api/end_users/summary \
  --header 'x-api-key: <api-key>'
{
  "_meta": {
    "limit": 100,
    "next_url": "<string>",
    "page": 1,
    "pages": 3,
    "prev_url": "<string>",
    "total": 350
  },
  "end_users": [
    {
      "end_user_id": "01401b6f-2399-47ee-aabe-744e8022ddfa",
      "confidence": 0.42,
      "created": "2025-11-09T16:03:58.689481",
      "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": 42.42
        }
      ],
      "crm_sync_result": {
        "crm_record_url": "<string>",
        "error_message": "<string>",
        "heron_id": "<string>",
        "name": "<string>",
        "occurred_at": "2023-11-07T05:31:56Z",
        "provider": "<string>",
        "result": "success",
        "success_message": "<string>"
      },
      "data_sources": [
        {
          "type": "pdf",
          "status": "new"
        }
      ],
      "files": [
        {
          "file_class": "<string>",
          "filename": "<string>",
          "heron_id": "<string>",
          "renamed_filename": "<string>"
        }
      ],
      "heron_id": "eus_C6jieqw8WGKuQnF9JZhSJB",
      "is_portfolio": true,
      "last_processed_at": "2025-12-21T16:03:58.689744",
      "last_updated": "2025-12-21T16:03:58.689515",
      "name": "Company Name Inc.",
      "policy_evaluations": [
        "passed"
      ],
      "profit_and_loss_layout": "<unknown>",
      "status": "ready"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
name
string | null

Filter by name associated with end user

Example:

"your_end_user_name"

​
status
enum<string> | null

Filter by status of end user

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

"reviewed"

​
end_user_id
string | null

Filter by ID associated with end_user_id field in transactions

Example:

"your_end_user_id"

​
page
integer | null

Pagination page number (optional). If provided, 'limit' must also be provided.

Required range: x >= 1
​
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
​
with_crm_sync_result
any | null
Available options:
success,
failure,
​
limit
integer | null

Pagination limit per page (optional). If provided, 'page' must also be provided.

Required range: 1 <= x <= 10000
​
include_data_sources
boolean
default:false

Whether the to include data sources for each end user

Example:

true

​
include_scorecard_metrics
boolean
default:false

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

Example:

true

​
heron_id
string | null

Unique ID generated by Heron

Example:

"eus_HKrcmyRyJuW5wZKbws8r7U"

​
interval_start
string<date-time> | null
​
with_policy_result
any | null
Available options:
passed,
failed,
missing_data,
​
interval_end
string<date-time> | null
​
is_portfolio
boolean | null

Whether the end user is part of a lending portfolio

Example:

true

Response

200 - application/json

OK

​
_meta
object

Pagination metadata. Present only if pagination parameters ('page' and 'limit') are provided in the request.

​
end_users
object[]