Penny Docs
Users

Update Current User

PATCH
/v1/users/me

Updates the authenticated user's display name and returns the updated profile.

Send only the fields you want to change. Omitted fields retain their current values.

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

Request Body

application/json

name?Name
Lengthlength <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/users/me" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}

Get Current User GET

Retrieves the user associated with the API token, including their profile, household memberships, selected household, and subscription summary. Use the…

Delete User Image DELETE

Removes the authenticated user's uploaded profile image. Subsequent profile responses return imageurl: null. Returns 204 with no response body on success,…