Skip to main content
GET
List Bank Statements

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
sort_by
enum<string>
default:created_at
Available options:
created_at,
period_start,
period_end
sort_order
enum<string>
default:desc
Available options:
asc,
desc
status__in
enum<string>[] | null

Filter by statement status (including SPLIT for parent statements)

Available options:
submitted,
processing,
invalid,
pending_approval,
approved,
split,
synced
date
string<date> | null

Filter by date - returns statements where this date falls within the period

search
string | null

Search in attachment filename

account_id
string | null

Filter by bank account ID

original_statement_id
string | null

Find child statements of a split parent

Response

Successful Response

data
BankStatementListItem · object[]
required

The list of records.

current_page
integer
default:0
required

The current page.

total_records
integer | null
required

Total number of records.

Required range: x >= 0
next_page
integer | null
required

The next page number, if one exists.