List transactions

Filterable, cursor-paginated transaction query.

List transactions

cURL

curl --request GET \
  --url https://breadbox.example.com/api/v1/transactions \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://breadbox.example.com/api/v1/transactions"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://breadbox.example.com/api/v1/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://breadbox.example.com/api/v1/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://breadbox.example.com/api/v1/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://breadbox.example.com/api/v1/transactions")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://breadbox.example.com/api/v1/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "transactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "short_id": "<string>",
      "account_id": "<string>",
      "connection_id": "<string>",
      "attributed_user_id": "<string>",
      "date": "2023-12-25",
      "authorized_date": "2023-12-25",
      "amount": "<string>",
      "iso_currency_code": "<string>",
      "name": "<string>",
      "merchant_name": "<string>",
      "counterparty_short_id": "<string>",
      "counterparty_name": "<string>",
      "counterparty_logo_url": "<string>",
      "category_id": "<string>",
      "pending": true,
      "deleted_at": "2023-11-07T05:31:56Z",
      "tags": [
        "<string>"
      ],
      "metadata": {},
      "flagged_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true,
  "limit": 123
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key · string · header · required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Query Parameters

cursor · string

Opaque pagination cursor returned by a previous list response.

limit · integer

Page size (default 50, capped per-endpoint).

Required range: 1 <= x <= 200

fields · string

Comma-separated field selector. Accepts column names and aliases (minimal, core, category, timestamps, triage, review_core, transaction_core). id and short_id are always included.

account_id · string

Filter by account UUID or short_id (repeatable).

connection_id · string

Filter by connection.

user_id · string

Filter by attributed user (uses COALESCE(attributed_user_id, connection.user_id)).

category_id · string

Filter by category.

tag · string

Filter by tag slug.

search · string

Substring/word/fuzzy search on name + merchant_name. Comma-separated values are OR'd.

search_mode · enum<string>

Search algorithm.

Available options: contains, words, fuzzy

exclude_search · string

Negative search filter (NOT ILIKE). Min 2 chars.

date_from · string<date>

date_to · string<date>

amount_min · number

amount_max · number

pending · boolean

flagged · boolean

Filter to flagged (true) or unflagged (false) transactions.

deleted · enum<string>

Whether to include or restrict to soft-deleted transactions.

Available options: include, only

Response

200

application/json

Paginated transaction list.

transactions · object[]

Show child attributes

next_cursor · string | null

has_more · boolean

limit · integer