curl --request GET \
--url https://breadbox.example.com/api/v1/providers \
--header 'X-API-Key: <api-key>'[
{
"name": "<string>",
"configured": true,
"needs_link_session": true,
"capabilities": [
"<string>"
],
"credentials_schema": {}
}
]List configured providers
Returns the self-describing registry of bank-data providers this server
supports, including which are configured, their capabilities, and the
shape of credentials they accept on POST /connections.
Unconfigured providers still appear with configured: false so clients
can render a “set me up” CTA without guessing what providers exist.
Response is a bare JSON array (bounded resource — see API conventions).
curl --request GET \
--url https://breadbox.example.com/api/v1/providers \
--header 'X-API-Key: <api-key>'[
{
"name": "<string>",
"configured": true,
"needs_link_session": true,
"capabilities": [
"<string>"
],
"credentials_schema": {}
}
]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.
Response
Provider registry.
Provider identifier (plaid, teller, csv, ...)
True when this provider's config is set on this server.
True when POST /providers/{name}/link-session returns a token; false when it returns 204.
Informational; e.g. transactions, balances.
Per-field descriptor for the credentials payload on POST /connections.
Show child attributes
Show child attributes