List transaction rules

get

https://api.cardda.com/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_start

integer

≥ 0

If all the transactions where in an array, this would represent the index of the first item returned in the response

_end

integer

≥ 0

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order

string

enum

The order method, which can be ascending or descending

Allowed:

_field

string

The field used to sort, the example illustrates a response that would be sorted by the creation date

merchant_id

uuid

Filter rules that reference the given merchant in their constraints.

name

string

Filter by name.

enabled

boolean

Filter by enabled state.

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Accounting endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized

404

The company-id header is missing or the caller is not a member of the company

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of transaction rules