Skip to main content
Returns all account links (connections) for the user. Each link represents a connection to a financial institution or payroll provider. Use the link_id from these results with getPayrollIncome or getBankIncome for detailed income data.

​
Parameters

No parameters required.

​
Response

FieldTypeDescription
[].link_idstringUnique link identifier
[].providerstringProvider name (e.g. “Chase”, “ADP”)
[].data_sourcestringpayroll or financial_accounts
[].statusstringConnection status

​
Example

Prompt: “What accounts do I have connected?” 
[
  {
    "link_id": "d192a4f1cc7f4f05a105c9dd8ab703fb",
    "provider": "Chase",
    "data_source": "financial_accounts",
    "status": "active"
  },
  {
    "link_id": "a83b2c1d4e5f6789012345abcdef0123",
    "provider": "ADP",
    "data_source": "payroll",
    "status": "active"
  }
]