Users
Get Current User
Retrieves the user associated with the API token, including their profile, household memberships, selected household, and subscription summary.
Use the household IDs in this response for household-scoped requests. Each household's role and access_status describe the caller's access to that 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
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/users/me"{ "id": "Us2mH7qB5kLp", "email": "user@example.com", "pending_email": "user@example.com", "name": "Avery Chen", "is_email_verified": true, "image_url": "https://cdn.penny.finance/users/Us2mH7qB5kLp.png", "has_password": true, "has_completed_onboarding": true, "marketing_emails_enabled": true, "social_accounts": [ { "provider": "apple" } ], "households": [ { "id": "Hh4vK8pQ2sLm", "name": "Chen Household", "image_url": "https://cdn.penny.finance/households/Hh4vK8pQ2sLm.png", "role": "owner", "finance_account_count": 4, "access_status": "available" } ], "selected_household_id": "Hh4vK8pQ2sLm", "subscription": { "status": "active", "entitlement_id": "penny_plus_annual" }, "accepted_invite_household_id": "Hh4vK8pQ2sLm"}