getAccount
Get Account - retrieves a single account by ID with optional data.
Authentication: required
Get Account - retrieves a single account by ID with optional data.
This handler returns a specific account where the specified user is either the owner
or a collaborator. It supports optional inclusion of computed balances, crypto
holdings, Plaid access object data, collaborators, and collaborator invitations.
Computed balance invariant: computedBalance is the sum of the account's
non-deleted transactions expressed in the 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 the request fails rather than returning a mixed-currency sum.
Authentication: Required (Bearer token)
Parameters:
- accountId (string, required): ID of the account to retrieve
- userId (string, required): ID of the user making the request
- includeComputedBalance (boolean, optional): Include computed account balance
- includeCryptoHoldings (boolean, optional): Include crypto holdings for crypto accounts
- includePlaidAccessObject (boolean, optional): Include Plaid integration data
- includeCollaborators (boolean, optional): Include list of collaborators
- includeCollaboratorInvitations (boolean, optional): Include pending collaborator invitations (owner only)
Returns:
- account (object): AccountWithCryptoHoldings object with requested data
Example:
{
"method": "getAccount",
"params": {
"accountId": "acc123",
"userId": "user123",
"includeComputedBalance": true,
"includeCryptoHoldings": true,
"includePlaidAccessObject": true,
"includeCollaborators": true,
"includeCollaboratorInvitations": true
}
}