Skip to main content
GET
Get User Bank Transactions V2

Authorizations

Authorization
string
header
required

Bearer authentication with a personal access token (prefix pat_). Generate tokens in the Truv web app under Settings → API keys.

Query Parameters

transacted_at_from
string
required

Start date for the transaction window (inclusive, YYYY-MM-DD).

Example:

"2025-01-01"

transacted_at_to
string

End date for the transaction window (inclusive, YYYY-MM-DD). Defaults to today.

Example:

"2025-12-31"

categories
string | null

Comma-separated category slugs to include (e.g. 'income,transfer'). Omit to include all categories.

Maximum string length: 1000
Example:

"income,transfer"

transaction_type
enum<string> | null

Filter by transaction type. Omit to include both debits and credits.

Available options:
DEBIT,
CREDIT
Example:

"DEBIT"

account_ids
string | null

Comma-separated account IDs to include. Omit to include all accounts.

Example:

"acc_001,acc_002"

min_amount

Minimum transaction amount (absolute value). Inclusive.

Example:

"10.00"

max_amount

Maximum transaction amount (absolute value). Inclusive.

Example:

"500.00"

merchant
string | null

Case-insensitive substring match on merchant name or description.

Example:

"starbucks"

exclude_categories
string | null

Comma-separated category slugs to exclude (e.g. 'transfer,uncategorized').

Maximum string length: 1000
sort_by
enum<string>
default:date

Sort transactions by date or absolute amount.

Available options:
date,
amount
Example:

"date"

sort_order
enum<string>
default:desc

Sort direction: ascending or descending.

Available options:
asc,
desc
Example:

"desc"

page
integer | null

1-based page number, defaulting to 1 when paginating. Pagination is off unless page or page_size is set; with neither set, all matching transactions are returned in one response.

Required range: x >= 1
Example:

1

page_size
integer | null

Transactions per page (min 10, max 500), defaulting to 500 when paginating. Pagination is off unless page or page_size is set; with neither set, all matching transactions are returned in one response.

Required range: 10 <= x <= 500
Example:

100

include_hidden
boolean
default:false

Include user-hidden transactions alongside visible ones. Hidden transactions can be unhidden; permanently deleted transactions are never returned regardless.

Example:

true

Response

Paginated bank transactions (v2, ClickHouse-backed).

count
integer
required
accounts
Account1 · object[]
required
transactions
Transaction1 · object[]
required
daily_totals
DailyTotal · object[]
merchant_logos
Merchant Logos · object
next
string | null
previous
string | null