Rule field catalog

GET

/rules/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.

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.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://api.synci.io/oauth/authorize

Token URL: https://api.synci.io/oauth/token

Responses

🟢200

application/json

Bodyapplication/json

🟠401AuthenticationException

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.synci.io/api/v1/rules/field-catalog' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": [
        null
    ]
}

Modified at 2026-07-24 17:31:52

Get rule

Update rule