Penny Docs
Households

Get Preferences

GET
/v1/households/{household_id}/preferences

Retrieves the household's shared display preferences, including whether recurring suggestions and advanced details are shown.

These settings apply to the household rather than an individual member. Viewers can read them.

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/households/string/preferences"
{  "show_recurring_suggestions": true,  "show_advanced_details": true}