List categorisation rules

GEThttps://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

activestringoptional

Filter by active status. Omit to return all rules.

truefalse

Response

200List of categorisation rules ordered by priority descending.

Show response fields

rulesarray<object>

Show child attributes

activeboolean

fieldstring

idinteger

namestring

operatorstring

priorityinteger

targetAccountCodestring

targetAccountIdstring

targetAccountNamestring

valuestring

totalinteger

RequestGET/v1/categorisation-rules/curl

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

Response200

{
  "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
  }
}