---
title: "List bank statements"
method: GET
path: "/connectivity/v2beta/connections/{cid}/reports/{id}/bank-statements"
tags: ["Connections"]
---

# List bank statements

`GET /connectivity/v2beta/connections/{cid}/reports/{id}/bank-statements`

## Request

- Base URL: `https://api.atlar.com`
- URL: `https://api.atlar.com/connectivity/v2beta/connections/{cid}/reports/{id}/bank-statements`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/atlar/apis/atlar-api-v2/docs/connectivity/v2beta/connections/:cid/reports/:id/bank-statements/get.ts> (a function with typed inputs; its response is checked against the schema)

List bank statements.

## Path parameters

- `cid` string, required
- `id` string, required

## Query parameters

- `limit` integer
- `token` string
- `account_id` string: Unique resource identifier.
- `type` 'EODY' | 'NONE'
- `from` string, date: `full-date` notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, `2017-07-21`.
- `to` string, date: `full-date` notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, `2017-07-21`.

## Response `200`

List of bank statements.

- object
  - `items` BankStatement[], required: A list of resources.
    - `organizationId` string, required: Unique resource identifier for an Organization.
    - `connectionId` string, required: Unique resource identifier for a Connection.
    - `reportId` string, required: Unique resource identifier for the ConnectionReport.
    - `accountId` string: Unique resource identifier.
    - `id` string, required: Unique resource identifier.
    - `type` 'BOOKED' | 'PENDING', required
    - `financialDataAccountId` string: Unique resource identifier for the corresponding financial data account.
    - `metadata` Metadata, nullable: Metadata is a `string-string` key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement. Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars. By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the [Metadata keys page](https://app.atlar.com/metadata-keys). Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.
    - `version` integer, required: Resource version. Starts at value `1` when the resource is created and increases by one for each successive update.
    - `etag` string, required: [ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the resource version. This can be passed along in `If-Match` HTTP header when updating a resource to perform a conditional update.
    - `created` string, date-time, required: Time at which the resource was created.
    - `updated` string, date-time, required: Time at which the resource was last updated.
  - `nextToken` string, required: Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.
  - `token` string, required: The pagination token that was used for this request. The value will be an empty string if no `token` query parameter was provided with the request.
  - `limit` integer, required: The page limit that was used for this request.

## Other responses

- `404`: Resource not found.

## Changes

- **2026-11-03** `b49df1e4b3e9`: 2 info
  - added the optional property `allOf[subschema #2]/items/items/metadata` to the response with the `200` status
  - added the optional property `details/items/metadata` to the response with the `404` status

[Operation history](https://skmtc.dev/atlar/apis/atlar-api-v2/changes/connectivity/v2beta/connections/:cid/reports/:id/bank-statements/get.md)

---

[API](https://skmtc.dev/atlar/apis/atlar-api-v2.md) - [All operations](https://skmtc.dev/atlar/apis/atlar-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/atlar/apis/atlar-api-v2/revisions/b49df1e4b3e9?raw)