Get Household Members
Lists the household's current members and pending invitations. Member records include their role and join date; invitation records include the invited role and expiration time.
Available to all household roles, including viewers, even when subscription access has lapsed.
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
curl -X GET "https://example.com/v1/households/string/members"{ "members": [ { "id": "Us2mH7qB5kLp", "name": "Avery Chen", "email": "user@example.com", "role": "owner", "image_url": "https://cdn.penny.finance/users/Us2mH7qB5kLp.png", "joined_at": "2019-08-24T14:15:22Z" } ], "invited": [ { "id": "Iv8qM3cT6nRa", "email": "user@example.com", "role": "owner", "invited_by_email": "user@example.com", "expires_at": "2019-08-24T14:15:22Z" } ]}Delete Household DELETE
Permanently deletes the household and its associated financial data for every member. Only the household owner can delete it, including when subscription…
Delete Household Image DELETE
Removes the household's uploaded image. Only the household owner can make this change; subsequent household responses return imageurl: null. Returns 204…