Returns the status of all Plaid connected financial account ledgers on the platform.
curl --request GET \
--url https://api.sandbox.teal.dev/v0/sources/plaid/links/status \
--header 'Authorization: Bearer <token>'
{
"next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
"prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
"records": [
{
"token_handle": {
"id": "UjL3BQnEaJtecuC7CUeDk",
"type": "plaid",
"date": "2022-01-01T00:00:00Z",
"enabled": true
},
"ledger": {
"id": "7JRNsKwy2Lw66caxVU7WGC",
"name": "Pluto Checking 4242",
"debit_credit": "debit",
"editable": false,
"financial_account_type": "bank_account",
"is_required": false,
"parent": {},
"parent_id": null,
"report_cash_flow": false,
"sort_code": "1400",
"sub_type": "current_assets",
"type": "asset"
},
"instance": {
"id": "RKtPbubK5NcbBsUmU1ktSP",
"entries_start": "2024-01-01T00:00:00Z",
"name": "ACME Goods Inc",
"subscription": "tier3",
"accounting_package": "platformgl",
"parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
"child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
"parent": {},
"children": [
{}
]
},
"txn_processing_task": {
"id": "UjL3BQnEaJtecuC7CUeDk",
"status": "pending",
"created_datetime": "2024-01-01T00:00:00Z",
"updated_datetime": "2024-01-01T00:00:00Z",
"error": null,
"source_account_id": "<string>",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"created_transaction_ids": [
"<string>"
],
"removed_transaction_ids": [
"<string>"
],
"modified_transaction_ids": [
"<string>"
],
"skipped_transaction_ids": [
"<string>"
]
}
}
]
}
The access token received from the authorization server in the OAuth 2.0 flow.
The Instance ID
The number of records to return. Max limit is 100.
1 <= x < 101
Successful Response
The response is of type object
.
curl --request GET \
--url https://api.sandbox.teal.dev/v0/sources/plaid/links/status \
--header 'Authorization: Bearer <token>'
{
"next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
"prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
"records": [
{
"token_handle": {
"id": "UjL3BQnEaJtecuC7CUeDk",
"type": "plaid",
"date": "2022-01-01T00:00:00Z",
"enabled": true
},
"ledger": {
"id": "7JRNsKwy2Lw66caxVU7WGC",
"name": "Pluto Checking 4242",
"debit_credit": "debit",
"editable": false,
"financial_account_type": "bank_account",
"is_required": false,
"parent": {},
"parent_id": null,
"report_cash_flow": false,
"sort_code": "1400",
"sub_type": "current_assets",
"type": "asset"
},
"instance": {
"id": "RKtPbubK5NcbBsUmU1ktSP",
"entries_start": "2024-01-01T00:00:00Z",
"name": "ACME Goods Inc",
"subscription": "tier3",
"accounting_package": "platformgl",
"parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
"child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
"parent": {},
"children": [
{}
]
},
"txn_processing_task": {
"id": "UjL3BQnEaJtecuC7CUeDk",
"status": "pending",
"created_datetime": "2024-01-01T00:00:00Z",
"updated_datetime": "2024-01-01T00:00:00Z",
"error": null,
"source_account_id": "<string>",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"created_transaction_ids": [
"<string>"
],
"removed_transaction_ids": [
"<string>"
],
"modified_transaction_ids": [
"<string>"
],
"skipped_transaction_ids": [
"<string>"
]
}
}
]
}