List Accounts - retrieves accounts for a specific user with optional data.
Use with an AI agent
Export this page as Markdown or bundle it with a task for your agent.
Try a task
Preview the prompt that will be copied
Reference
Authentication: bearer token required (see how to get a token)
List Accounts - retrieves accounts for a specific user with optional data.
This handler returns all accounts where the specified user is either the owner
or a collaborator. It supports optional inclusion of computed balances, crypto
holdings, and Plaid access object data.
Computed balance invariant: each account's computedBalance is the sum of its
non-deleted transactions expressed in that account's own currency. A transaction
denominated in a different currency (Plaid isoCurrencyCode) is converted to the
account currency using the latest USD-normalized fiat rate before summing.
Negative amounts (refunds/reversals) sum naturally. If a required rate is
unavailable, a legacy computed-balance request fails rather than returning a
mixed-currency sum; exact-balance requests mark the affected account unavailable.
Authentication: Required (Bearer token)
Parameters:
- userId (string, required): ID of the user whose accounts to retrieve
- includeComputedBalance (boolean, optional): Include computed account balances
- includeExactComputedBalance (boolean, optional): Include exact computed balances as string units and decimal scales. Accounts whose exact balance cannot be computed return exactComputedBalanceUnavailable instead of a balance. When both balance options are requested, computedBalance is the numeric hundredths projection of the exact balance.
- includeCryptoHoldings (boolean, optional): Include crypto holdings for crypto accounts
- includePlaidAccessObject (boolean, optional): Include Plaid integration data
Returns:
- accounts (array): Array of AccountWithCryptoHoldings objects
Example:
{
"method": "listAccounts",
"params": {
"userId": "user123",
"includeComputedBalance": true,
"includeCryptoHoldings": true,
"includePlaidAccessObject": true
}
}