List categorisation rules

GET https://app.speybooks.com/api/v1/categorisation-rules/

Returns all categorisation rules for the authenticated organisation, ordered by priority descending then creation date ascending. Optionally filter by active status.

Query parameters

active string optional

Filter by active status. Omit to return all rules.

truefalse

Response

200 List of categorisation rules ordered by priority descending.

Show response fields

rules array<object>

Show child attributes

active boolean

field string

id integer

name string

operator string

priority integer

targetAccountCode string

targetAccountId string

targetAccountName string

value string

total integer

Request GET /v1/categorisation-rules/ curl

curl https://api.speybooks.com/v1/categorisation-rules?active=true \
  -H "Authorization: Bearer sk_test_..."

Response 200

{
  "success": true,
  "data": {
    "rules": [
      {
        "id": 5,
        "name": "Tesco",
        "field": "description",
        "operator": "contains",
        "value": "TESCO",
        "targetAccountId": "acc_7400",
        "targetAccountCode": "7400",
        "targetAccountName": "Office Expenses",
        "priority": 50,
        "active": true
      }
    ],
    "total": 12
  }
}