Skip to main content
GET
Retrieve a connection

Authorizations

Authorization
string
header
required

Authorization: Bearer rbk_live_...

Redbark-Version
string
header
required

The API release your integration is built against, e.g. 2026-10-01.wattle. Required on every request.

Path Parameters

id
string
required

The id of the object.

Example:

"conn_2Bc4De6fGh8jKl0mNp3qRs"

Query Parameters

include[]

Related objects to expand inline. Repeat the parameter for more than one; see each resource for its includes.

Response

The connection

id
string
required
Example:

"conn_2Bc4De6fGh8jKl0mNp3qRs"

object
enum<string>
required
Available options:
connection
provider
required
Available options:
fiskil,
akahu,
snaptrade
category
enum<string>
required
Available options:
banking,
brokerage
institution
object
required
status
enum<string>
required
Available options:
pending,
active,
expiring,
expired,
invalidated,
revoked
accounts
object[] | null
required

include[]=accounts

account_count
integer
required
last_refreshed_at
string<date-time> | null
required
Example:

"2026-08-21T09:30:00.000Z"

ready_at
string<date-time> | null
required
Example:

"2026-08-21T09:30:00.000Z"

metadata
object | null
required

Up to 50 string pairs. Set a key to null in an update to unset it.

livemode
boolean
required
created
string<date-time>
required
Example:

"2026-08-21T09:30:00.000Z"

updated
string<date-time>
required
Example:

"2026-08-21T09:30:00.000Z"