Skip to main content
POST
/
api
/
v1
/
connections
/
{id}
/
reauth-complete
Complete reauth flow
curl --request POST \
  --url https://breadbox.example.com/api/v1/connections/{id}/reauth-complete \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
{
  "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

​
X-API-Key
string
header
required

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

​
id
string
required

UUID or 8-char short_id.

Body

application/json

The body is of type object.

Response

200 - application/json

Updated connection.

​
id
string
​
short_id
string
​
user_id
string
​
provider
enum<string>
Available options:
plaid,
teller,
csv
​
institution_name
string | null
​
institution_id
string | null
​
status
enum<string>
Available options:
active,
error,
pending_reauth,
disconnected
​
paused
boolean
​
sync_interval_seconds
integer | null
​
last_sync_at
string<date-time> | null
​
next_sync_at
string<date-time> | null
​
created_at
string<date-time>
​
updated_at
string<date-time>