Skip to main content
Rules

Rule field catalog

Returns the fields a rule action can set, grouped by reach, one entry per rule scope (BANK, TRANSFER). Each group carries the action_type to submit and the destinations it reaches, so the editor can render a single grouped field picker and derive the action type from the chosen field — the user never picks an action type directly.

GET
/rules/field-catalog

The catalog is static (not per-rule); render the entry matching the rule being edited. For transfer rules being attached to a bank account as output rules, restrict to groups where output_compatible is true.

Authorizations

Authorizationstringheaderrequired

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

Response

application/json
dataany[]required

Still need help? Ask the team