HEherondata
EndUsers

List EndUsers with Summary Information

Changed on

Get a list of EndUsers

get/api/end_users/summary

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/end_users/summary
  • Auth
    API key in header x-api-key

Query parameters

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

is_portfolioboolean nullable
Example:true

Whether the end user is part of a lending portfolio

order_by'last_updated_desc' | 'last_updated_asc' | 'created_desc' | 'created_asc' | 'null' nullable

Order to return end users by

heron_idstring nullable
Example:eus_9D9H6wDjjCyEvEjx3AoRSX

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

tagsstring[] nullable

Filter by tag Heron IDs. End users holding any active requested tag are returned. Unknown and soft-deleted tag IDs do not match any end users.

pageinteger nullable

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

limitinteger nullable

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

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)

include_tagsboolean
Example:true

Whether to include the tags applied to each end user

with_policy_resultunknown

Only end users whose policy result was this.

with_crm_sync_resultunknown
in_human_reviewboolean nullable

Filter by whether an active document is pending human review

include_submitting_brokersboolean
Example:true

Whether to include the brokers who submitted each end user

lendsaas_deal_idsstring[] nullable

Only end users linked to any of these LendSaaS deal IDs. Requires a LendSaaS CRM integration.

include_lendsaas_deal_idsboolean
Example:true

Whether to include the LendSaaS deal IDs linked to each end user

include_crm_queueboolean
Example:true

Whether to include the CRM queue each end user's workflow last synced it to (currently read from LendSaaS sync steps)

interval_startstring date-time nullable
interval_endstring date-time nullable
include_updates_in_intervalboolean

When true, interval_start and interval_end match end users created or last updated within the window. Bounds are inclusive only when this flag is true.

Response

OK

Example response

{
  "end_users": [
    {
      "confidence": 0.42,
      "created": "2026-09-22T13:48:17.145047",
      "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": "8dc2ffc4-b5b2-4daa-9912-f2b05a4c8b1e",
      "heron_id": "eus_W2yb7hSzruhnvUKW2ysUs8",
      "is_portfolio": true,
      "last_processed_at": "2026-11-03T13:48:17.145471",
      "last_updated": "2026-11-03T13:48:17.145083",
      "name": "Company Name Inc.",
      "status": "ready"
    }
  ]
}

Changes

  • bd8008e49534Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new execution_error enum value to the //// response property for the response status

    • warning

      added the new execution_error enum value to the /// response property for the response status

    • warning

      added the new skipped enum value to the //// response property for the response status

    • warning

      added the new skipped enum value to the /// response property for the response status

    • info

      added the new optional query request parameter in_human_review

    • info

      added the new optional query request parameter include_crm_queue

    • info

      added the new optional query request parameter include_lendsaas_deal_ids

    • info

      added the new optional query request parameter include_submitting_brokers

    • info

      added the new optional query request parameter include_tags

    • info

      added the new optional query request parameter lendsaas_deal_ids

    • info

      added the new optional query request parameter tags

    • info

      added the new enum value execution_error to the query request parameter with_policy_result

    • info

      added the new enum value undefined to the query request parameter order_by

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added to the response property allOf list for the response status