Start a provider link session
curl --request POST \
--url https://breadbox.example.com/api/v1/providers/{name}/link-session \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"user_id": "<string>"
}
'{
"link_token": "<string>",
"expiration": "2023-11-07T05:31:56Z"
}Connections
Start a provider link session
Generic link-token start. Replaces the deprecated provider-specific link-token routes.
- Providers that need a server-issued init token (Plaid today;
MoneyKit / Salt Edge in the future) return
200 OKwith{link_token, expiration}. - Providers whose hosted UI runs entirely client-side (Teller, CSV)
return
204 No Content— the client proceeds straight toPOST /connectionswith the credentials it collected.
Requires full_access scope.
POST
/
api
/
v1
/
providers
/
{name}
/
link-session
Start a provider link session
curl --request POST \
--url https://breadbox.example.com/api/v1/providers/{name}/link-session \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"user_id": "<string>"
}
'{
"link_token": "<string>",
"expiration": "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
Available options:
plaid, teller, csv Body
application/json
UUID or short_id
⌘I