Penny Docs
Households

Update Preferences

PATCH
/v1/households/{household_id}/preferences

Updates the household's shared display preferences and returns the resulting settings. Requires a member or owner role.

Send only the preferences you want to change; omitted values are preserved. Changes apply to all members of the household.

Authorization

PersonalApiToken
AuthorizationBearer <token>

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

household_id*Household Id

Request Body

application/json

show_recurring_suggestions?Show Recurring Suggestions
show_advanced_details?Show Advanced Details

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/households/string/preferences" \  -H "Content-Type: application/json" \  -d '{}'
{  "show_recurring_suggestions": true,  "show_advanced_details": true}

Get Preferences GET

Retrieves the household's shared display preferences, including whether recurring suggestions and advanced details are shown. These settings apply to the…

Get Accounts GET

Lists the household's non-deleted financial accounts grouped by account type. Account balances retain their native currencies; group and household totals…