List Households
Lists every household the authenticated user belongs to, including its currency, timezone, preferences, and the user's role.
Use access_status to determine whether a household is available before requesting its financial data. The response includes the complete list without pagination.
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
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/households"{ "households": [ { "id": "Hh4vK8pQ2sLm", "name": "Chen Household", "currency": "AED", "timezone": "America/Los_Angeles", "image_url": "https://cdn.penny.finance/households/Hh4vK8pQ2sLm.png", "role": "owner", "preferences": { "show_recurring_suggestions": true, "show_advanced_details": true }, "access_status": "available" } ]}Upload User Image PUT
Uploads or replaces the authenticated user's profile image and returns its display URL. Send the image as the file field in a multipart/form-data request.…
Create Household POST
Creates a household with the supplied name, reporting currency, and timezone, and makes the authenticated user its owner. The household is initialized with…