Get connection
curl --request GET \
--url https://breadbox.example.com/api/v1/connections/{id} \
--header 'X-API-Key: <api-key>'{
"id": "<string>",
"short_id": "<string>",
"user_id": "<string>",
"institution_name": "<string>",
"institution_id": "<string>",
"paused": true,
"sync_interval_seconds": 123,
"last_sync_at": "2023-11-07T05:31:56Z",
"next_sync_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Connections
Get connection
GET
/
api
/
v1
/
connections
/
{id}
Get connection
curl --request GET \
--url https://breadbox.example.com/api/v1/connections/{id} \
--header 'X-API-Key: <api-key>'{
"id": "<string>",
"short_id": "<string>",
"user_id": "<string>",
"institution_name": "<string>",
"institution_id": "<string>",
"paused": true,
"sync_interval_seconds": 123,
"last_sync_at": "2023-11-07T05:31:56Z",
"next_sync_at": "2023-11-07T05:31:56Z",
"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.
Response
Connection.
Available options:
plaid, teller, csv Available options:
active, error, pending_reauth, disconnected ⌘I