curl --request GET \
--url https://breadbox.example.com/api/v1/headless/bootstrap \
--header 'X-API-Key: <api-key>'{
"version": "<string>",
"encryption_key_set": true,
"database": {
"connected": true,
"migrations_current": true,
"migration_version": 123
},
"providers": [
{
"configured": true,
"env": "<string>"
}
],
"users_count": 123,
"login_accounts_count": 123,
"api_keys_count": 123,
"active_connections_count": 123,
"scheduler_running": true,
"first_run": true
}Setup readiness report
Returns a one-shot readiness/setup summary intended for the
breadbox doctor CLI command. Any API key (read or write) works.
Fields are best-effort — a per-row failure stays zero and the report
still ships. The endpoint returns 503 only when the database is
plainly unreachable.
curl --request GET \
--url https://breadbox.example.com/api/v1/headless/bootstrap \
--header 'X-API-Key: <api-key>'{
"version": "<string>",
"encryption_key_set": true,
"database": {
"connected": true,
"migrations_current": true,
"migration_version": 123
},
"providers": [
{
"configured": true,
"env": "<string>"
}
],
"users_count": 123,
"login_accounts_count": 123,
"api_keys_count": 123,
"active_connections_count": 123,
"scheduler_running": true,
"first_run": true
}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
Bootstrap report.
Readiness/setup summary consumed by breadbox doctor.
Server build version.
True when ENCRYPTION_KEY is set.
Show child attributes
Show child attributes
Provider configuration status. Order is stable (plaid, teller).
Show child attributes
Show child attributes
Household user count.
Admin / dashboard login account count.
Active (un-revoked) API key count.
Bank connections in 'active' status.
True when the sync scheduler has active cron entries.
True when login_accounts_count == 0 — the same signal used by the admin first-run redirect.