Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.redbark.co/llms.txt

Use this file to discover all available pages before exploring further.

The REST API is in beta. This endpoint’s response shape may change.
Returns all active connections for the authenticated user. A connection is a linked bank from a specific provider.

Request

GET /v1/connections

Headers

HeaderRequiredDescription
AuthorizationYesBearer YOUR_API_KEY
This endpoint takes no query parameters. All connections are returned in a single response.

Response

Ordered by createdAt descending (most recent first).
{
  "data": [
    {
      "id": "b7c4a1e2-8d3f-4e9a-9c5b-1f2a3e4d5c6b",
      "provider": "fiskil",
      "category": "banking",
      "institutionId": "77",
      "institutionName": "Westpac",
      "institutionLogo": "https://cdn.redbark.co/logos/westpac.png",
      "status": "active",
      "lastRefreshedAt": "2026-03-13T02:30:00.000Z",
      "createdAt": "2026-01-15T10:00:00.000Z"
    },
    {
      "id": "d9e2f3a4-5b6c-7d8e-9f01-2345abcdef67",
      "provider": "fiskil",
      "category": "banking",
      "institutionId": "21",
      "institutionName": "Commonwealth Bank",
      "institutionLogo": "https://cdn.redbark.co/logos/commbank.png",
      "status": "active",
      "lastRefreshedAt": "2026-03-12T18:00:00.000Z",
      "createdAt": "2026-02-20T14:30:00.000Z"
    }
  ]
}

Connection object

FieldTypeDescription
idstringUUID of the connection
providerstring"fiskil" (AU banking), "akahu" (NZ banking), or "snaptrade" (brokerage)
categorystring"banking" or "brokerage"
institutionIdstringOpaque provider-specific institution identifier. Numeric string for Fiskil (e.g. "77"), UUID for SnapTrade. Treat as an arbitrary string.
institutionNamestringInstitution display name (e.g. “Westpac”, “Interactive Brokers”)
institutionLogostring | nullURL to the institution logo, or null if unavailable
statusstringOne of "active", "invalidated" (consent or credentials expired — user needs to reconnect), "pending_mfa" (awaiting a second factor), or "revoked" (consent withdrawn)
lastRefreshedAtstring | nullISO 8601 timestamp of the last successful data refresh
createdAtstringISO 8601 timestamp of when the connection was created
Connections with status "deleting" (mid-teardown) are excluded from the response.

Examples

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.redbark.co/v1/connections
import requests

resp = requests.get(
    "https://api.redbark.co/v1/connections",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
connections = resp.json()["data"]

for conn in connections:
    print(f"{conn['institutionName']} ({conn['provider']}): {conn['status']}")
const resp = await fetch("https://api.redbark.co/v1/connections", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data: connections } = await resp.json();

for (const conn of connections) {
  console.log(`${conn.institutionName} (${conn.provider}): ${conn.status}`);
}