Get account
curl --request GET \
--url https://breadbox.example.com/api/v1/accounts/{id} \
--header 'X-API-Key: <api-key>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"short_id": "<string>",
"name": "<string>",
"display_name": "<string>",
"official_name": "<string>",
"type": "<string>",
"subtype": "<string>",
"mask": "<string>",
"iso_currency_code": "<string>",
"balance_current": "<string>",
"balance_available": "<string>",
"balance_limit": "<string>",
"is_excluded": true,
"is_dependent_linked": true,
"connection_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Accounts
Get account
GET
/
api
/
v1
/
accounts
/
{id}
Get account
curl --request GET \
--url https://breadbox.example.com/api/v1/accounts/{id} \
--header 'X-API-Key: <api-key>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"short_id": "<string>",
"name": "<string>",
"display_name": "<string>",
"official_name": "<string>",
"type": "<string>",
"subtype": "<string>",
"mask": "<string>",
"iso_currency_code": "<string>",
"balance_current": "<string>",
"balance_available": "<string>",
"balance_limit": "<string>",
"is_excluded": true,
"is_dependent_linked": true,
"connection_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}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.
Path Parameters
UUID or 8-char short_id.
Query Parameters
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.
Response
Single account.
Decimal as string.
Available options:
plaid, teller, csv ⌘I