---
title: "List EndUsers"
method: GET
path: "/api/end_users"
tags: ["EndUsers"]
---

# List EndUsers

`GET /api/end_users`

Get a list of EndUsers

## Query parameters

- `heron_id` string, nullable
- `end_user_id` string, nullable
- `name` string, nullable
- `status` 'new' | 'ready' | 'processed' | 'reviewed' | 'review_requested' | 'failed' | 'null', nullable
- `page` integer
- `limit` integer
- `order_by` 'last_updated_desc' | 'last_updated_asc' | 'created_desc' | 'created_asc'
- `is_portfolio` boolean, nullable
- `include_data_sources` boolean
- `include_scorecard_metrics` boolean

## Response `200`

OK

- object
  - `_meta` object
    - `limit` integer
    - `next_url` string
    - `page` integer
    - `pages` integer
    - `prev_url` string
    - `total` integer
  - `end_users` EndUser[]
    - `confidence` number — Aggregated confidence for the end user across all transactions; between 0 and 1
    - `created` string, date-time — When the end user was created in Heron system
    - `criteria` Metric[] — List of scorecard metrics
      - `context` 'higher_is_better' | 'lower_is_better' | 'null', nullable — Context for how to interpret the metric, e.g., whether a higher value is 'better' than a lower value
      - `currency` string, nullable — The ISO currency code for metric, where applicable
      - `date_range` 'latest' | 'last_30_days' | 'last_90_days' | 'last_120_days' | 'last_180_days' | 'last_365_days' | 'next_30_days' | 'next_60_days' | 'next_90_days' | 'next_180_days' | 'last_1_calendar_months' | 'last_3_calendar_months' | 'last_4_calendar_months' | 'last_6_calendar_months' | 'last_12_calendar_months' | 'last_15_calendar_months' | 'last_24_calendar_months' | 'last_1_full_calendar_months' | 'last_2_full_calendar_months' | 'last_3_full_calendar_months' | 'last_6_full_calendar_months' | 'last_12_full_calendar_months' | 'last_60_days' | 'last_45_days' | 'last_2_calendar_months' — Metric date range
      - `description` string, nullable — Description of metric
      - `group` 'data_quality' | 'processing_quality' | 'balance' | 'profit_and_loss' | 'debt' | 'risk_flag' | 'forecast' | 'heron' | 'ml_feature' — The type of metric
      - `label` string — Metric label, slugified
      - `status` 'available' | 'partially_available' | 'not_available' | 'null', nullable — either 'calculated' or 'not_available' depending on the requested date range vs. date range of the data
      - `unit` 'n' | 'day' | 'ratio' | 'amount' | 'weekday' | 'array' | 'probability' — The unit of measurement for metric
      - `value` unknown
    - `data_sources` DataSource[] — List of data source summaries for the end user
      - `status` 'new' | 'parsing' | 'parsed' | 'processed' | 'human_reviewing' | 'approved' | 'rejected' | 'failed' | 'transactions_loaded' | 'transactions_unloaded' | 'pending' | 'active' | 'syncing' | 'erroring' | 'sync_disabled' | 'deleted_in_plaid' | 'unknown' — Status of the data source entity, where applicable (e.g. pdfs, integration links)
      - `type` 'api' | 'csv' | 'pdf' | 'integration_link' | 'legacy' | 'legacy_pdf' | 'legacy_integration_link', required — Data source type
    - `end_user_id` string, required — id defined by user; links to the end_user_id for transactions
    - `heron_id` string — Unique id for end user generated by Heron
    - `is_portfolio` boolean — Whether the end user is part of a lending portfolio
    - `last_processed_at` string, date-time — When the end user was last successfully processed in Heron system
    - `last_updated` string, date-time — When the end user was last updated in Heron system
    - `meta` object, nullable — Arbitrary key-value metadata. Max 20 keys, key ≤64 chars, value ≤256 chars, total ≤4KB. Example: {"attribution_key": "lender_42"}
    - `name` string, nullable — Name of end user; may help to improve categorisation accuracy
    - `profit_and_loss_layout` unknown
    - `status` 'new' | 'ready' | 'processed' | 'reviewed' | 'review_requested' | 'failed' — Status of end user; 'ready' triggers async processing, 'review_requested' triggers manual review request

---

[API](https://skmtc.dev/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/herondata/heron-data-api/revisions/f2e441edece2/schema)