List Rules
Lists the household's active transaction rules in priority order, highest priority first, with their conditions and actions.
Use this order when presenting rules for editing or sending the complete list to the reorder endpoint. The response is not paginated.
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/rules"{ "rules": [ { "id": "Rl9cF3nV7sQa", "priority": 1, "account_ids": [ "Ac7kP2mN9qRs" ], "merchant_ids": [ "Mr9dL3xT6bQa" ], "category_ids": [ "Ct5nR8wY1jFu" ], "amount_filter": { "direction": "income", "operator": "equals", "value": "68.42", "value_upper": "100.00" }, "penny_detailed_categories": [ "RENT_AND_UTILITIES_RENT" ], "name_conditions": [ { "pattern": "BLUE BOTTLE", "mode": "contains" } ], "filter_uncategorized": true, "set_category_id": "Ct5nR8wY1jFu", "set_merchant_id": "Mr9dL3xT6bQa", "apply_tag_ids": [ "Tg8qN1cK5rWd" ], "set_hidden": true, "set_needs_review": true, "applied_count": 18 } ]}Update Tag PUT
Replaces a tag's name and color and returns the updated tag. Existing transaction assignments are retained. Supply both fields, using color: null to clear…
Create Rule POST
Creates a transaction rule at the highest priority in the household. Define matching conditions and actions such as assigning a category or merchant, adding…