List Merchants
Lists all active merchants in the household, including their display images and counts of visible transactions and recurring series.
The response is not paginated. Deleted merchants are excluded; merchants with no transactions are still returned.
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
application/json
curl -X GET "https://example.com/v1/households/string/merchants"{ "merchants": [ { "id": "Mr9dL3xT6bQa", "name": "Blue Bottle Coffee", "website": "https://www.bluebottlecoffee.com/", "image_url": "https://cdn.penny.finance/merchants/blue-bottle-coffee.png", "default_image_url": "https://cdn.penny.finance/merchants/default-coffee.png", "transaction_count": 18, "recurring_transaction_count": 1 } ]}Update Category Group PUT
Renames a category group and returns the updated group. Its type and existing category assignments are preserved. The new name must be unique within the…
Create Merchant POST
Creates a merchant in the household for use on transactions and recurring series. Returns the merchant with its resolved image URL and usage counts. The…