Skip to main content
GET
List suggested categorization rules
You can set show_affected_transactions=true to preview transactions each suggestion would recategorize. For more details about previewing suggestions, see Rule Suggestions.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json.

Path Parameters

businessId
string<uuid>
required

The UUID of the business.

Query Parameters

show_affected_transactions
boolean
default:false

Include a transactions_that_will_be_affected preview on each suggestion.

statuses
string

Comma-separated list of suggestion statuses to filter by.

Example:

"PENDING"

update_type
enum<string>

Filter by the suggestion's update type.

Available options:
CREATE_RULE,
CREATE_RULE_FROM_SUGGESTIONS
direction
enum<string>

Filter by bank transaction direction.

Available options:
MONEY_IN,
MONEY_OUT
counterparty_id
string<uuid>

Filter suggestions by counterparty UUID.

account_identifiers
string

Comma-separated list of account identifiers to filter by.

q
string

Free-text search query across suggestion fields.

limit
integer

Maximum number of results per page.

sort_by
string
default:created_at

Field to sort by (default: created_at).

sort_order
enum<string>
default:DESC

Sort order (ASC or DESC). Defaults to DESC.

Available options:
ASC,
DESC
pagination_cursor
string

Pagination cursor for fetching next page.

Response

200 - application/json

List of suggested categorization rule updates.

data
object[]
required
meta
object

Request metadata. Present on paginated list responses.