Penny Docs
Users

Upload User Image

PUT
/v1/users/me/image

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. Accepts JPEG, PNG, or WebP up to 5 MiB (5,242,880 bytes) and 25 million decoded pixels, including all animation frames.

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

multipart/form-data

file*File
Formatbinary

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/users/me/image" \  -F file="string"
{  "image_url": "https://cdn.penny.finance/merchants/blue-bottle-coffee.png"}

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,…

List Households GET

Lists every household the authenticated user belongs to, including its currency, timezone, preferences, and the user's role. Use accessstatus to determine…