curl --request GET \
--url https://breadbox.example.com/api/v1/transactions \
--header 'X-API-Key: <api-key>'{
"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>",
"category_id": "<string>",
"category_override": true,
"pending": true,
"deleted_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>",
"has_more": true,
"limit": 123
}List transactions
Filterable, cursor-paginated transaction query.
curl --request GET \
--url https://breadbox.example.com/api/v1/transactions \
--header 'X-API-Key: <api-key>'{
"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>",
"category_id": "<string>",
"category_override": true,
"pending": true,
"deleted_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>",
"has_more": true,
"limit": 123
}Documentation Index
Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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
Opaque pagination cursor returned by a previous list response.
Page size (default 50, capped per-endpoint).
1 <= x <= 200Comma-separated field selector. Accepts column names and aliases
(minimal, core, category, timestamps, triage, review_core,
transaction_core). id and short_id are always included.
Filter by account UUID or short_id (repeatable).
Filter by connection.
Filter by attributed user (uses COALESCE(attributed_user_id, connection.user_id)).
Filter by category.
Filter by tag slug.
Substring/word/fuzzy search on name + merchant_name. Comma-separated values are OR'd.
Search algorithm.
contains, words, fuzzy Negative search filter (NOT ILIKE). Min 2 chars.
Whether to include or restrict to soft-deleted transactions.
include, only Filter by manual override flag.