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": {}
}
'import requests
url = "https://breadbox.example.com/api/v1/connections/plaid/exchange"
payload = {
"public_token": "<string>",
"user_id": "<string>",
"metadata": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({public_token: '<string>', user_id: '<string>', metadata: {}})
};
fetch('https://breadbox.example.com/api/v1/connections/plaid/exchange', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://breadbox.example.com/api/v1/connections/plaid/exchange",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'public_token' => '<string>',
'user_id' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://breadbox.example.com/api/v1/connections/plaid/exchange"
payload := strings.NewReader("{\n \"public_token\": \"<string>\",\n \"user_id\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://breadbox.example.com/api/v1/connections/plaid/exchange")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"public_token\": \"<string>\",\n \"user_id\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://breadbox.example.com/api/v1/connections/plaid/exchange")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"public_token\": \"<string>\",\n \"user_id\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"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"
}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.
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": {}
}
'import requests
url = "https://breadbox.example.com/api/v1/connections/plaid/exchange"
payload = {
"public_token": "<string>",
"user_id": "<string>",
"metadata": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({public_token: '<string>', user_id: '<string>', metadata: {}})
};
fetch('https://breadbox.example.com/api/v1/connections/plaid/exchange', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://breadbox.example.com/api/v1/connections/plaid/exchange",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'public_token' => '<string>',
'user_id' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://breadbox.example.com/api/v1/connections/plaid/exchange"
payload := strings.NewReader("{\n \"public_token\": \"<string>\",\n \"user_id\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://breadbox.example.com/api/v1/connections/plaid/exchange")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"public_token\": \"<string>\",\n \"user_id\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://breadbox.example.com/api/v1/connections/plaid/exchange")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"public_token\": \"<string>\",\n \"user_id\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"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"
}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 Last modified on June 24, 2026
⌘I