---
title: "Get the current user"
method: GET
path: "/api/users/current"
tags: ["Users"]
---

# Get the current user

`GET /api/users/current`

## Request

- Base URL: `https://app.herondata.io`
- URL: `https://app.herondata.io/api/users/current`
- Auth: API key in header `x-api-key`

## Response `200`

OK

- object
  - `member` object: The logged-in member's customer roles in this environment, from the session.
    - `roles` string[]
  - `user` User
    - `alias` string
    - `available_deal_stages` string[]: Deal stages this tenant's pipeline can produce; empty for non-broker use cases.
    - `created` string, date-time
    - `email` string, required
    - `environment` 'dev' | 'prod' | 'internal'
    - `id` integer
    - `is_active` boolean
    - `is_self_sign_up` boolean, nullable
    - `last_updated` string, date-time
    - `onboarding_data` object, nullable
    - `onboarding_step` unknown
    - `onboarding_step_initial_data` object, nullable
    - `organization_id` integer, required
    - `password` string
    - `profit_and_loss_layout` unknown
    - `settings` UserSettings
      - `annotations` AnnotationSettings
        - `annotators` AnnotatorSettings[]
          - `async_` boolean
          - `confidence_threshold` number
          - `label` string
          - `sync` boolean
        - `heron_ai_chunk_size` integer
        - `llm_counterparty_extraction_and_clustering_enabled` boolean
        - `llm_counterparty_extraction_chunk_size` integer
        - `reconcile` boolean
        - `reconcile_version` string
        - `slug` 'us_sme_lend_2' | 'ca_sme_lend_2' | 'gb_sme_lend_2' | 'gb_sme_lender' | 'us_sme_lender' | 'us_consumer' | 'smartbiz_loans' | '24' | '30' | '171' | 'capchase'
        - `split_intra_co_transfers_to_inflows_outflows` boolean
        - `split_p2p_to_inflows_outflows` boolean
      - `api_version` string
      - `cache_global_enrich` boolean
      - `currency_iso_code` 'GBP' | 'USD' | 'EUR' | 'CAD' | 'AUD'
      - `data_retention_days` integer, nullable
      - `data_retention_turned_on` boolean
      - `email_domains` string[]
      - `enabled_enrichers` string[]
      - `end_user_entities` EndUserEntitiesSettings
        - `date_display_format` string: The format to use for date attributes when they are display in the dashboard
      - `end_user_query_static_csvs` object: Static CSV configurations for end user queries. Dict mapping table_name to gcs_path.
      - `enrich_global_ttl_days` integer
      - `enricher_inputs_mapping` object: Mapping of enricher names to input field names. Used to map LLM enricher inputs to end user fields.
      - `features` FeatureSettings
        - `acknowledge_submission_emails` boolean
        - `auto_dsa_deduplication_enabled` boolean
        - `auto_iso_app_parsing_enabled` boolean
        - `auto_sync_to_crm` boolean
        - `background_check_affiliations` boolean
        - `background_check_trial_limit` integer, nullable
        - `bank_statement_human_review_enabled` boolean
        - `bank_statement_summary` BankStatementSummarySettings
          - `monthly_summary_averages_and_totals_exclude_partial_months` boolean
          - `monthly_summary_averages_and_totals_partial_month_leniency_days` integer
        - `broker_alert_on_failed_funder_submission` boolean
        - `broker_decision_name_match_window_days` integer
        - `broker_failed_funder_submission_alert_addresses` string[]
        - `broker_submission_dedupe_window_days` integer, nullable
        - `broker_submission_email_cc_deal_owner` boolean
        - `broker_submission_use_generated_files_as_iso_app` boolean: Dashboard-triggered funder submissions attach the deal's latest generated_file as the ISO application instead of the uploaded application files, matching the SubmitToFunders node's use_generated_files_as_iso_app input. Set for brokers whose workflow generates the application but leaves submission to the dashboard.
        - `broker_velocity_signal` BrokerVelocitySignal
          - `high_threshold` integer
          - `low_threshold` integer
          - `medium_threshold` integer
        - `broker_waterfall_alert_addresses` string[]
        - `broker_waterfall_min_decline_percentage` integer, nullable
        - `categorisation_beta` CategorisationBeta
          - `merchants_beta` boolean
          - `positions_beta` boolean
          - `rich_heuristics_beta` boolean
        - `count_duplicate_end_users` boolean
        - `crm_sync_end_users_without_end_user_information` boolean
        - `crm_sync_n8n_workflow_url` string, nullable
        - `crm_sync_n8n_workflow_urls` string[], nullable
        - `custom_merchant_groups_auto_approve` boolean
        - `custom_merchant_groups_enabled` boolean
        - `custom_merchant_groups_to_override` string[]
        - `daily_crm_sync_report_emails` string[]
        - `decision_engine` DecisionEngineSettings
          - `beta` boolean
          - `enabled` boolean
        - `default_regular_debt_summary` boolean
        - `description_masked` boolean
        - `end_user_created_alert_slack_channel` string, nullable
        - `evaluate_policies_only_in_flowmingo` boolean
        - `failed_iso_email_forwarding_addresses` string[]
        - `file_classifier_fallback_model_registry_slug` string, nullable
        - `file_classifier_model_registry_slug` string, nullable
        - `financials_alerting_enabled` boolean
        - `financials_enabled` boolean
        - `flowmingo_workflow_owners` FlowmingoWorkflowOwners
          - `group_slack_name` string[]
          - `user_email` string[]
        - `forward_failed_emails` boolean
        - `forward_rejected_emails` boolean
        - `fraud_network_scanning` boolean
        - `grouped_recurring_transactions_enabled` boolean
        - `has_end_user_in_description` boolean
        - `has_matching_transaction` boolean
        - `heron_score` boolean
        - `heron_score_min_category_confidence` number
        - `identify_positions` boolean
        - `incident_reprocess_opt_out` boolean
        - `is_insurance_demo` boolean
        - `is_potential_duplicate` boolean
        - `is_recurring` boolean
        - `iso_app_parser_version` string
        - `iso_app_parsing` boolean
        - `kyb_ui_demo` boolean
        - `kyb_verification` boolean
        - `lookup_crm_id_in_email_body` boolean
        - `mcp_apps_widgets` boolean
        - `merchant` boolean
        - `openai_file_classifier_model_slug` string, nullable
        - `path_to_spreadsheet_export_template` string, nullable
        - `policy_auto_decline` boolean
        - `policy_auto_pdf_parsing` boolean
        - `policy_auto_pdf_parsing_sequential` boolean
        - `policy_stop_if_iso_app_not_fully_matched` boolean
        - `predict_naics` boolean
        - `read_from_entity_graph` boolean
        - `rejected_iso_email_forwarding_addresses` string[]
        - `reply_to_rejected_emails` boolean
        - `report_bank_statement_summary_num_calendar_months_to_show` integer, nullable
        - `report_bank_statement_summary_use_location_specific_months` boolean
        - `require_attachments_in_submissions` boolean
        - `resolve_owners_across_iso_applications` boolean
        - `restrict_end_user_access_by_tag` boolean: Permission gate: when on, a dashboard member can only see end users sharing one of the tags assigned to them in Stytch. Members with no tags assigned, API keys, and legacy credentials stay unrestricted.
        - `send_email_after_failed_policy_workflow_reason` object
        - `show_background_check` boolean
        - `show_debt_candidates_table` boolean
        - `skip_send_email_after_failed_crm_sync_cron` boolean
        - `skip_trial_end_user_alerts` boolean
        - `small_file_filtering_enabled` boolean
        - `sos_suggest_first` boolean
        - `spreadsheet_export_date_columns` string[], nullable: List of query result columns to export as spreadsheet dates. If null, query values are unchanged.
        - `spreadsheet_export_eusql_queries` string[], nullable: List of end user SQL query names to include in spreadsheet export. If null, all queries are exported. If empty list, no queries are exported.
        - `spreadsheet_export_exclude_hardcoded_sheets` string[], nullable: List of hardcoded sheet names to exclude from spreadsheet export. If null, no sheets are excluded. Only applies to hardcoded sheets, not query sheets.
        - `store_entity_graph` boolean
        - `submission_finish_event_loopback_days` integer
        - `submission_finish_event_status` boolean
        - `sync_to_crm_after_failed_policy_workflow_reason` object
        - `temporal_workflow_as_policy_workflow` boolean
        - `temporal_workflow_enabled` boolean
        - `webhook_event_created_timestamp` boolean
        - `webhook_retry_backoffs` integer[]
      - `files` FileSettings
        - `combined_file_classification_enable_automatic_splitting` boolean
        - `combined_file_classification_enabled` boolean
        - `combined_file_classification_keywords` string[]
        - `combined_file_classification_num_pages_threshold` integer
        - `combined_file_classification_treat_excel_files_as_combined` boolean
        - `disable_automatic_parsing` string[]: a list of file classes to disable automatic parsing for.
        - `file_class_parsers_map` object
        - `gcs_import_classifies_files` boolean
        - `human_in_the_loop` object: Configuration for human review per parser. Keys are parser_ids.
        - `reject_duplicates` boolean
        - `reject_duplicates_based_on_text` boolean
        - `required_file_classes` string[]
        - `total_allowed_files_to_process` integer, nullable
      - `high_priority_async_slots` integer
      - `inbound_emails` InboundEmailSettings
        - `allowed_from_addresses` string[]
        - `allowed_from_domains` string[]
        - `allowed_to_addresses` string[]
        - `blocked_from_domains` string[]
        - `email_classification_ignored_domains` string[]: The customer's own email domains. Addresses from these domains are excluded from the rule-based broker/lender role assignment, since they typically belong to the lender/operator rather than the broker submitting the deal. For example, if big_capital.com is listed and we receive an email from bob@big_capital.com, Bob will not be automatically assigned the broker role — though the LLM may still assign it if the email content suggests otherwise.
        - `match_emails_with_same_subject_line` boolean: Whether to group re-submissions with the same subject line into the same end user
        - `skip_to_address_check_from_domains` string[]
      - `include_in_analytics` boolean
      - `ip_whitelist` string[], nullable
      - `is_priority_async` boolean
      - `legacy_data_sources` boolean
      - `modifiable` ModifiableSettings
        - `balance_sheet_categories` BalanceSheetCategories
          - `current_assets` object
          - `current_liabilities` object
          - `equity` object
          - `fixed_assets` object
          - `non_current_liabilities` object
          - `other_assets` object
        - `bank_statement_summary_columns` string[], nullable
        - `disable_data_export` boolean
        - `financials_metrics` object
        - `funder_submission_email_fields` FunderSubmissionEmailFieldSettings
          - `broker_contact_number` boolean
          - `broker_name` boolean
          - `business_address` boolean
          - `business_dba` boolean
          - `business_federal_tax_id` boolean
          - `business_industry` boolean
          - `business_legal_name` boolean
          - `business_start_date` boolean
          - `business_state_of_incorporation` boolean
          - `funding_amount_requested` boolean
          - `funding_annual_revenue` boolean
          - `funding_loan_purpose` boolean
          - `funding_monthly_revenue` boolean
          - `owner_date_of_birth` boolean
          - `owner_name` boolean
          - `submission_notes` boolean
        - `industry_naics_enabled` boolean
        - `low_balance_days_threshold` number
        - `pnl_categories` PnLCategories
          - `cogs` object
          - `income` object
          - `operating_expenses` object
          - `other_expenses` object
          - `other_income` object
        - `query_reports` QueryReportTabGroup[]
          - `tab_group` string, required
          - `tabs` QueryReportTab[], required
            - `tab_name` string, required
            - `widgets` QueryReportWidget[], required
              - …
        - `required_revenue_per_month` integer
        - `restricted_industries` RestrictedIndustry[]
          - `description` string
          - `name` string
        - `transactions_review_enabled` boolean
        - `use_new_company_layout` boolean
        - `use_new_end_user_summary_table` boolean
        - `use_new_end_user_table` boolean
      - `outbound_emails` OutboundEmailSettings
        - `allowed_to_domains` string[]
        - `restrict_outbound_emails_to_allowed_domains` boolean
      - `pdf` PdfSettings
        - `alteration_amber_score` integer
        - `alteration_red_score` integer
        - `alteration_summary_llm` boolean
        - `auto_approve_passing_pdfs` boolean
        - `auto_fail` boolean
        - `created_disabled_dsa_for_excluded_statements` boolean
        - `enabled` boolean
        - `fraud_detection` boolean
        - `heron_before_moneythumb` boolean
        - `identity_account_suffix` boolean
        - `include_failed_statuses_in_finished_pdfs` boolean
        - `include_items_returned_unpaid` boolean
        - `jitl_file_outcome` boolean
        - `jitl_opt_in_auto_reject_codes` boolean
        - `load_unreconciled_transactions` union
          - boolean
          - LoadUnreconciledTransactionsRule[]
            - `file_class` string, required
            - `filters` LoadUnreconciledTransactionsFilters
              - …
        - `max_fraud_score` integer
        - `max_pdfs_to_parse` integer, nullable
        - `override_pdf_parsing_with_temporal_flow` boolean
        - `parsing_version` '0.0.0' | '1.0.0' | '2.0.0' | '3.0.0' | '4.0.0' | '4.1.0' | '5.0.0' | '6.0.0' | '7.0.0' | '7.1.0' | '8.0.0'
        - `reject_duplicated_based_on_text` boolean
        - `reject_duplicates` boolean
        - `revision_checks` boolean
        - `show_alteration_result` boolean
        - `show_anomaly_score_result` boolean
        - `use_cache` boolean
        - `wells_fargo_iru_same_day_pairing` boolean
      - `plaid` PlaidSettings
        - `account_types_enabled_for_analysis` string[]
        - `account_types_to_ingest` string[]
        - `assets_report_days_to_sync` integer
        - `auto_enrich_after_sync` boolean
        - `balance_anchor_field` 'current' | 'posted'
        - `days_to_sync` integer
        - `owner_types_enabled_for_analysis` string[]
        - `store_raw_responses` boolean
      - `rate_limit` string
      - `restrict_api_keys_in_dashboard` boolean
      - `restrict_downloading_data` boolean
      - `retry_global_enrich` boolean
      - `scorecard` ScorecardSettings
        - `balance_prediction` boolean
        - `company_overview_layout` WidgetGroup[]
          - `group_name` string, required
          - `id` string, required: A unique id used to reference the group
          - `widgets` Widget[], required
            - `id` string, required: A unique id used to reference the widget
            - `scorecard_metric_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'
            - `scorecard_metric_label` string
            - `type` 'scorecard_metric' | 'heron_score' | 'loan_revenue_ratio' | 'deposit_trends_ratio', required
        - `metrics_benchmarks` boolean
      - `slack_channel_id` string, nullable
      - `sync_async_enrich` boolean
      - `sync_enrich` boolean
      - `use_case_type` 'iso_underwriting' | 'non_iso_underwriting' | 'commercial_insurance' | 'commercial_law' | 'equipment_finance' | 'broker' | 'other'
      - `use_ses_outbound` boolean
    - `username` string, required

## Changes

- **2026-11-03** `4f9eaaa87f09`: 1 info
  - added the optional property `user/settings/pdf/show_anomaly_score_result` to the response with the `200` status
- **2026-11-03** `1ec936e17fef`: 1 info
  - added the optional property `user/settings/pdf/jitl_opt_in_auto_reject_codes` to the response with the `200` status
- **2026-11-03** `bd8008e49534`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/herondata/apis/heron-data-api/changes/api/users/current/get.md)

---

[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.dev/herondata/apis/heron-data-api/revisions/36168f46a500?raw)