Get Accounts
Lists the household's non-deleted financial accounts grouped by account type. Account balances retain their native currencies; group and household totals use the household's reporting currency.
Closed accounts remain in the response and contribute zero to displayed balances. Use the deleted-accounts endpoint to find accounts available for restoration.
Authorization
PersonalApiToken Use your personal API token (penny_pat_…) as the bearer credential. Enter the token only; the client adds the Bearer prefix. Read-only tokens permit read requests. Read/write tokens remain limited by your current household membership and role. See https://penny.finance/docs/api#authentication for setup.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/households/string/accounts"{ "groups": [ { "type": "depository", "accounts": [ { "id": "Ac7kP2mN9qRs", "mask": "4821", "name": "Everyday Checking", "type": "depository", "current_balance": { "amount": "68.42", "currency": "USD" }, "currency": "USD", "household_id": "Hh4vK8pQ2sLm", "user_name": "Daily spending", "provider": "plaid", "transaction_count": 184, "is_closed": false, "linked_at": "2019-08-24T14:15:22Z", "last_synced_at": "2019-08-24T14:15:22Z", "added_by_id": "Us2mH7qB5kLp", "plaid": { "item_id": "item_sandbox_8d4f1c2a", "connection_status": "healthy", "error_code": "ITEM_LOGIN_REQUIRED" }, "image_url": "https://cdn.penny.finance/institutions/chase.png", "default_image_url": "https://cdn.penny.finance/accounts/checking.png" } ], "total": { "amount": "68.42", "currency": "USD" } } ], "total_balance": { "amount": "68.42", "currency": "USD" }}Update Preferences PATCH
Updates the household's shared display preferences and returns the resulting settings. Requires a member or owner role. Send only the preferences you want…
List Deleted Accounts GET
Lists the household's deleted accounts, most recently deleted first, with their retained balance and transaction metadata. Use an account's ID with the…