Sign in

v3

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0162167359.9 KB
Transactions

Transaction volume breakdown

Volume + count grouped by tag or type, with the same filters as the list.

get/api/v1/transactions/breakdown

Query parameters

groupBy'tag' | 'type' required

Field to group breakdown analytics by.

Group by tag or type

typestring nullable

Comma-separated transaction types

Comma-separated transaction types

incomeOnlyboolean nullable
tagstring nullable

Comma-separated tags

Comma-separated tags

statusstring nullable

Comma-separated unified statuses

Comma-separated unified statuses

contactIdstring nullable

Comma-separated contact UUIDs

Comma-separated contact UUIDs

bank_account_idstring nullable

Comma-separated bank account UUIDs

Comma-separated bank account UUIDs

bankAccountIdstring nullable

Comma-separated bank account UUIDs

Comma-separated bank account UUIDs

cardIdstring nullable

Comma-separated Card UUIDs

Comma-separated Card UUIDs

fromDatestring date-time nullable
toDatestring date-time nullable
qstring nullable

Free-text search across description, merchant, tag, hash/wallet, contact name, counterparty user, invoice contractor, IBAN, and exact amount. Min 2 chars; values shorter are ignored.

Free-text search across description, merchant, tag, hash/wallet, contact name, counterparty user, invoice contractor, IBAN, and exact amount. Min 2 chars; values shorter are ignored.

Headers

x-api-keystring nullable

Response

Successful Response

groupBy'tag' | 'type' required

Field to group breakdown analytics by.