Exchange a Plaid public_token
curl --request POST \
--url https://breadbox.example.com/api/v1/connections/plaid/exchange \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"public_token": "<string>",
"user_id": "<string>",
"metadata": {}
}
'{
"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
Exchange a Plaid public_token
deprecated
Deprecated — use POST /api/v1/connections with provider:"plaid" instead.
This route remains as a thin pass-through to the generic dispatch path.
Trades a one-time public_token for a long-lived access token, persists
the connection, and triggers an initial sync. Requires full_access scope.
POST
/
api
/
v1
/
connections
/
plaid
/
exchange
Exchange a Plaid public_token
curl --request POST \
--url https://breadbox.example.com/api/v1/connections/plaid/exchange \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"public_token": "<string>",
"user_id": "<string>",
"metadata": {}
}
'{
"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.
Response
201 - application/json
Created connection.
Available options:
plaid, teller, csv Available options:
active, error, pending_reauth, disconnected ⌘I