Retrieve a link session
curl --request GET \
--url https://api.redbark.com/v2/link_sessions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Redbark-Version: <api-key>'const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Redbark-Version': '<api-key>'}
};
fetch('https://api.redbark.com/v2/link_sessions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.redbark.com/v2/link_sessions/{id}"
headers = {
"Authorization": "Bearer <token>",
"Redbark-Version": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text){
"id": "ls_7Kp3Lm5nQr7sTu9vWx1yZa",
"object": "link_session",
"provider": "fiskil",
"institution": "<string>",
"status": "pending",
"url": "<string>",
"connection": "<string>",
"start_token": "<string>",
"return_url": "<string>",
"failure_reason": "<string>",
"expires_at": "2026-08-21T09:30:00.000Z",
"completed_at": "2026-08-21T09:30:00.000Z",
"metadata": {},
"livemode": true,
"created": "2026-08-21T09:30:00.000Z",
"updated": "2026-08-21T09:30:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}Link sessions
Retrieve a link session
Retrieves one link session by id, including its status and the connection it produced once completed.
GET
/
link_sessions
/
{id}
Retrieve a link session
curl --request GET \
--url https://api.redbark.com/v2/link_sessions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Redbark-Version: <api-key>'const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Redbark-Version': '<api-key>'}
};
fetch('https://api.redbark.com/v2/link_sessions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.redbark.com/v2/link_sessions/{id}"
headers = {
"Authorization": "Bearer <token>",
"Redbark-Version": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text){
"id": "ls_7Kp3Lm5nQr7sTu9vWx1yZa",
"object": "link_session",
"provider": "fiskil",
"institution": "<string>",
"status": "pending",
"url": "<string>",
"connection": "<string>",
"start_token": "<string>",
"return_url": "<string>",
"failure_reason": "<string>",
"expires_at": "2026-08-21T09:30:00.000Z",
"completed_at": "2026-08-21T09:30:00.000Z",
"metadata": {},
"livemode": true,
"created": "2026-08-21T09:30:00.000Z",
"updated": "2026-08-21T09:30:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}Authorizations
Authorization: Bearer rbk_live_...
The API release your integration is built against, e.g. 2026-10-01.wattle. Required on every request.
Path Parameters
The id of the object.
Example:
"ls_7Kp3Lm5nQr7sTu9vWx1yZa"
Response
The link session
Example:
"ls_7Kp3Lm5nQr7sTu9vWx1yZa"
Available options:
link_session Available options:
fiskil, akahu, snaptrade, plaid Available options:
pending, completed, expired, failed Hosted page to send the user to while pending
Returned once, in the creating response, and only to Redbark's own apps; null everywhere else. Send it as the X-Redbark-Link-Start request header when opening url.
Example:
"2026-08-21T09:30:00.000Z"
Example:
"2026-08-21T09:30:00.000Z"
Up to 50 string pairs. Set a key to null in an update to unset it.
Show child attributes
Show child attributes
Example:
"2026-08-21T09:30:00.000Z"
Example:
"2026-08-21T09:30:00.000Z"

