v1 is deprecated. It stays available and unchanged for existing integrations, but it gets no new fields and will be sunset no earlier than 12 months after v2 reaches general availability (announced with
Deprecation / Sunset headers). Build new work on API v2; see migrating from v1.The REST API is in beta. This endpoint’s response shape may change.
Request
GET /v1/connections
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer YOUR_API_KEY |
Response
Ordered bycreatedAt descending (most recent first).
{
"data": [
{
"id": "b7c4a1e2-8d3f-4e9a-9c5b-1f2a3e4d5c6b",
"provider": "fiskil",
"category": "banking",
"institutionId": "77",
"institutionName": "Westpac",
"institutionLogo": "https://cdn.redbark.com/logos/westpac.png",
"status": "active",
"lastRefreshedAt": "2026-03-13T02:30:00.000Z",
"createdAt": "2026-01-15T10:00:00.000Z",
"consentExpiresAt": "2027-01-15T10:00:00.000Z"
},
{
"id": "d9e2f3a4-5b6c-7d8e-9f01-2345abcdef67",
"provider": "fiskil",
"category": "banking",
"institutionId": "21",
"institutionName": "Commonwealth Bank",
"institutionLogo": "https://cdn.redbark.com/logos/commbank.png",
"status": "active",
"lastRefreshedAt": "2026-03-12T18:00:00.000Z",
"createdAt": "2026-02-20T14:30:00.000Z",
"consentExpiresAt": "2027-02-20T14:30:00.000Z"
}
]
}
Connection object
| Field | Type | Description |
|---|---|---|
id | string | UUID of the connection |
provider | string | "fiskil" (AU banking), "akahu" (NZ banking), or "snaptrade" (brokerage) |
category | string | "banking" or "brokerage" |
institutionId | string | Opaque provider-specific institution identifier. Numeric string for Fiskil (e.g. "77"), UUID for SnapTrade. Treat as an arbitrary string. |
institutionName | string | Institution display name (e.g. “Westpac”, “Interactive Brokers”) |
institutionLogo | string | null | URL to the institution logo, or null if unavailable |
status | string | One of "active", "invalidated" (consent or credentials expired — user needs to reconnect), "pending_mfa" (awaiting a second factor), or "revoked" (consent withdrawn) |
lastRefreshedAt | string | null | ISO 8601 timestamp of the last successful data refresh |
createdAt | string | ISO 8601 timestamp of when the connection was created |
consentExpiresAt | string | null | ISO 8601 timestamp of when the connection’s data-sharing consent expires. CDR (AU banking) consents last at most 12 months from grant — the connection stops returning data at expiry until the user reconsents. null when the connection has no consent expiry (e.g. brokerage connections). |
Connections with status
"deleting" (mid-teardown) are excluded from the response.Examples
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.redbark.com/v1/connections
import requests
resp = requests.get(
"https://api.redbark.com/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.com/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}`);
}