---
title: "List transaction rules"
method: GET
path: "/platform/v1/workspaces/{workspaceId}/transaction-rules"
tags: ["transactionRules"]
---

# List transaction rules

`GET /platform/v1/workspaces/{workspaceId}/transaction-rules`

Returns the workspace's transaction rules in application order. Results are paged with `limit`/`offset`.

## Path parameters

- `workspaceId` string, uuid, required

## Query parameters

- `limit` integer
- `offset` integer, nullable

## Response `200`

200

- object
  - `data` object[], required
    - `actions` union[], required
      - union
        - object
          - `actionType` 'account_id', required
          - `value` string, uuid, required — Chart of accounts account id to book matching transactions to.
        - object
          - `actionType` 'account_name', required
          - `value` string, required — Chart of accounts account name to book matching transactions to. The account must exist on every entity the rule covers.
        - object
          - `actionType` 'accrual_account_id', required
          - `value` object, required — Accrual-basis account id to book matching transactions to. Requires the accrual ledger.
            - `accountId` string, uuid, required
            - `autoConfirm` boolean
        - object
          - `actionType` 'accrual_account_name', required
          - `value` object, required — Accrual-basis account name to book matching transactions to. Requires the accrual ledger.
            - `accountName` string, required
            - `autoConfirm` boolean
        - object
          - `actionType` 'class', required
          - `value` string[], required — Class ids to assign to matching transactions.
        - object
          - `actionType` 'memo', required
          - `value` string, required — Memo text to set on matching transactions.
        - object
          - `actionType` 'entity', required
          - `value` string, uuid, required — Entity id to move matching transactions to.
    - `conditions` union[], required
      - union
        - object
          - `conditionType` 'description_is', required
          - `value` string[], required — Bank descriptions the transaction description must equal (any of).
        - object
          - `conditionType` 'description_includes', required
          - `value` string[], required — Keywords the transaction description must contain (any of).
        - object
          - `conditionType` 'description_does_not_include', required
          - `value` string[], required — Keywords the transaction description must not contain.
        - object
          - `conditionType` 'amount', required
          - `value` object, required — Inclusive amount range the transaction must fall into.
            - `max` number
            - `min` number
        - object
          - `conditionType` 'date', required
          - `value` object, required — Calendar day range (YYYY-MM-DD) the transaction date must fall into.
            - `after` string
            - `before` string
        - object
          - `conditionType` 'amount_is_round', required
          - `value` object, required — Rounding level the transaction amount must match.
            - `isCredit` boolean, required
            - `level` 'dollar' | 'ten' | 'hundred' | 'thousand', required
        - object
          - `conditionType` 'amount_is_not_round', required
          - `value` object, required — Rounding level the transaction amount must not match.
            - `isCredit` boolean, required
            - `level` 'dollar' | 'ten' | 'hundred' | 'thousand', required
        - object
          - `conditionType` 'entity', required
          - `value` string[], required — Entity ids the transaction must belong to. When omitted on create, the rule covers all entities of the workspace.
        - object
          - `conditionType` 'financial_accounts', required
          - `value` string[], required — Financial account ids (as exposed by the Plaid connection endpoints) the transaction must come from.
        - object
          - `conditionType` 'class', required
          - `value` string[], required — Class ids the transaction must be assigned to.
    - `id` string, uuid, required
    - `isDisabled` boolean, required — Disabled rules are kept but no longer applied.
    - `note` string, nullable, required
    - `updatedAt` string, date-time, required
  - `pagination` object, required
    - `limit` integer, required
    - `offset` integer, required
    - `total` integer, required

## Other responses

- `400` — 400
- `401` — 401
- `404` — 404
- `429` — 429

---

[API](https://skmtc.net/kick/apis/kick-platform-api.md) · [All operations](https://skmtc.net/kick/apis/kick-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kick/kick-platform-api/revisions/e4ceb0dc32d4/schema)