Get Rule
Retrieves an active household rule with its priority, matching conditions, and actions.
Returns rule_not_found if the rule is deleted or does not belong to this household. Reading a rule does not evaluate or apply it.
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
application/json
curl -X GET "https://example.com/v1/households/string/rules/string"{ "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}Dry Run POST
Previews which visible transactions match a proposed rule's conditions without saving a rule or changing transactions. Returns overall match and transaction…
Delete Rule DELETE
Deletes a household rule so it is no longer applied to transactions. Changes previously made by the rule, including assigned categories and tags, are…