HEherondata
EndUsers

List EndUsers

Changed on

Get a list of EndUsers

get/api/end_users

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/end_users
  • 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

created_afterstring nullable
Example:2026-09-11

Return only end users created at or after this ISO 8601 date or datetime

created_beforestring nullable
Example:2026-09-18

Return only end users created strictly before this ISO 8601 date or datetime

last_updated_afterstring nullable
Example:2026-09-11

Return only end users last updated at or after this ISO 8601 date or datetime

last_updated_beforestring nullable
Example:2026-09-18

Return only end users last updated strictly before this ISO 8601 date or datetime

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_KgkieSTGXHSiu8A3uuQUaT

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

Pagination page number

limitinteger

Pagination limit per page

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

Response

OK

Example response

{
  "end_users": [
    {
      "confidence": 0.42,
      "created": "2026-09-21T23:44:30.608625",
      "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": "2f537176-cbcd-4a71-b083-a9335d6c694d",
      "heron_id": "eus_hyaMkfjmgiZgrk4d2rMbok",
      "is_portfolio": true,
      "last_processed_at": "2026-11-02T23:44:30.608873",
      "last_updated": "2026-11-02T23:44:30.608656",
      "name": "Company Name Inc.",
      "status": "ready"
    }
  ]
}

Changes

  • bd8008e49534Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter created_after

    • info

      added the new optional query request parameter created_before

    • info

      added the new optional query request parameter include_tags

    • info

      added the new optional query request parameter last_updated_after

    • info

      added the new optional query request parameter last_updated_before

    • info

      added the new optional query request parameter tags

    • 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