---
title: "List flagged bank statements"
method: GET
path: "/api/end_user_files/alteration_flags"
tags: ["EndUserFiles"]
---

# List flagged bank statements

`GET /api/end_user_files/alteration_flags`

## Request

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

List the latest amber or red alteration flag for each live bank statement.

## Query parameters

- `since` string, date, nullable
- `months` 1 | 3 | 6 | 12 | null, nullable
- `risk` string[]
- `search` string, nullable
- `limit` integer
- `cursor` string, nullable

## Response `200`

OK

- object
  - `_meta` object
    - `next_cursor` string, nullable
    - `per_page` integer
    - `total` integer, nullable: Matching flags, capped at 10,000. Counted on the first page only.
    - `total_capped` boolean, nullable: True when total hit the 10,000 cap. Null after the first page.
  - `flags` AlterationFlagSchema[]
    - `bank_name` string, nullable, required
    - `end_user_file_heron_id` string, required
    - `end_user_heron_id` string, required
    - `end_user_name` string, nullable, required
    - `filename` string, nullable, required
    - `flagged_at` string, date-time, required
    - `label` string, required
    - `risk` 'red' | 'amber', required
    - `statement_periods` AlterationFlagStatementPeriod[], required
      - `end` string, nullable, required
      - `start` string, nullable, required
    - `uploaded_at` string, date-time, required
    - `why` string, required

## Changes

- **2026-11-03** `bd8008e49534`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/herondata/apis/heron-data-api/changes/api/end_user_files/alteration_flags/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/1ec936e17fef?raw)