---
title: "List transaction rules"
method: GET
path: "/v1/transaction/rules"
tags: ["Transaction rule"]
---

# List transaction rules

`GET /v1/transaction/rules`

Returns a paginated list of the company's transaction rules (automations that match
transactions and apply custom-column change effects). Each rule includes its
`custom_column_change_effects` and `related_merchants`. Optionally filter by `merchant_id`.
Requires the `transactions_rules_view` or `transactions_rules_manage` permission; hidden
rules are excluded for non-admins.

## Query parameters

- `_start` integer
- `_end` integer
- `_order` 'asc' | 'desc'
- `_field` string
- `merchant_id` string, uuid
- `name` string
- `enabled` boolean

## Headers

- `company-id` string, uuid, required

## Response `200`

Paginated list of transaction rules

- TransactionRule[]
  - `id` string, uuid, required
  - `company_id` string, uuid, required
  - `user_id` string — The user who created the rule.
  - `name` string, required
  - `constraints` object — Match expression evaluated against transactions (MongoDB-style operators, e.g. `$or` with per-merchant clauses).
  - `enabled` boolean
  - `hidden` boolean
  - `related_merchants` object[] — Merchants referenced by the rule's constraints.
    - `id` string, uuid
    - `name` string
    - `image_url` string, nullable
  - `custom_column_change_effects` object[] — The custom-column changes applied when the rule matches.
    - `id` string, uuid
    - `rule_id` string, uuid
    - `type` string
    - `custom_column_id` string, uuid, nullable
    - `target_attribute` string, nullable
    - `target_value` string, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `created_at` string, date-time
  - `updated_at` string, date-time

## Other responses

- `401` — Unauthorized
- `404` — The `company-id` header is missing or the caller is not a member of the company

---

[API](https://skmtc.net/cardda/apis/banking-api.md) · [All operations](https://skmtc.net/cardda/apis/banking-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cardda/banking-api/versions/ff1aeb3fda8b/schema)