curl --request GET \
--url https://breadbox.example.com/api/v1/connections/link/{id} \
--header 'X-API-Key: <api-key>'{
"id": "<string>",
"short_id": "<string>",
"user_id": "<string>",
"connection_id": "<string>",
"single_use": true,
"redirect_url": "<string>",
"label": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"result_connection_ids": [
"<string>"
],
"expires_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}Poll a hosted-link session
Returns the current state of a hosted-link session. Accepts either the
canonical UUID or the 8-char short_id as {id}.
The plaintext bearer token and the constructed url are returned
only at creation time — this poll endpoint omits them. Use
result_connection_ids (always present, possibly empty) to find the
connections the user added during the session once status reaches
completed.
Status values: pending, active, completed, failed, expired.
curl --request GET \
--url https://breadbox.example.com/api/v1/connections/link/{id} \
--header 'X-API-Key: <api-key>'{
"id": "<string>",
"short_id": "<string>",
"user_id": "<string>",
"connection_id": "<string>",
"single_use": true,
"redirect_url": "<string>",
"label": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"result_connection_ids": [
"<string>"
],
"expires_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_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
Hosted-link session.
A hosted-link session is the agent-facing record of a "share this URL
with the user so they can connect a bank in their browser" flow.
Returned by GET /connections/link/{id} and (extended with token
and url) by POST /connections/link.
"plaid", "teller", or empty string. Empty means the hosted page
shows a picker so the user chooses a provider.
plaid, teller link, relink Present only for action: "relink" — the connection being re-authenticated.
Optional URL the hosted page redirects to after completion.
Optional human-readable label shown in the agent's audit timeline.
pending, active, completed, failed, expired, consumed Present only on status: "failed".
Present only on status: "failed".
UUIDs of the bank connections the user added during the session. Always present; empty array until at least one connection has been recorded.
Stamped when the hosted page first transitions the session to active.
Stamped when the session reaches completed or failed.