Skip to main content
GET
/
api
/
v1
/
providers
/
{name}
Get a single provider entry
curl --request GET \
  --url https://breadbox.example.com/api/v1/providers/{name} \
  --header 'X-API-Key: <api-key>'
{
  "name": "<string>",
  "configured": true,
  "needs_link_session": true,
  "capabilities": [
    "<string>"
  ],
  "credentials_schema": {}
}

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

​
name
enum<string>
required
Available options:
plaid,
teller,
csv

Response

Provider entry.

​
name
string
required

Provider identifier (plaid, teller, csv, ...)

​
configured
boolean
required

True when this provider's config is set on this server.

​
needs_link_session
boolean
required

True when POST /providers/{name}/link-session returns a token; false when it returns 204.

​
capabilities
string[]
required

Informational; e.g. transactions, balances.

​
credentials_schema
object
required

Per-field descriptor for the credentials payload on POST /connections.