FireFly III

Read, update, write and delete data using the powerful FireFly III API

Actions45

Overview

The "List Rules" operation of the "Rules & Groups API" resource in this node retrieves a paginated list of rules from the FireFly III API. This operation is useful for users who want to programmatically access and manage their financial automation rules within FireFly III, such as reviewing existing rules or integrating rule data into workflows.

Practical examples include:

Automatically fetching all defined rules to display them in a dashboard.
Integrating with other systems to audit or analyze financial rules.
Using the list of rules as input for further automated processing or reporting.

Properties

Name	Meaning
X-Trace-ID	A unique UUID identifier for the request, used for debugging and tracing (e.g., `123e4567-e89b-12d3-a456-426614174000`). Optional but helpful for tracing requests.
Pagination Options	Collection of pagination settings: • Limit: Max number of results to return (minimum 1, default 50). • Page: The page number to retrieve (minimum 1, default 1).

Output

The output JSON contains the response from the FireFly III API endpoint /rules with the applied pagination parameters. It typically includes an array of rule objects along with metadata about pagination (such as total count, current page, etc.). Each rule object represents a financial automation rule configured in FireFly III.

No binary data is returned by this operation.

Example structure (simplified):

{
  "data": [
    {
      "id": 1,
      "name": "Rule name",
      "active": true,
      "conditions": [...],
      "actions": [...],
      ...
    },
    ...
  ],
  "meta": {
    "total": 100,
    "per_page": 50,
    "current_page": 1,
    "last_page": 2
  }
}

Dependencies

Requires an authenticated connection to the FireFly III API using an OAuth2 or similar API authentication credential.
The node expects the FireFly III API base URL and credentials to be configured in n8n.
No additional external dependencies are required beyond the API access.

Troubleshooting

Empty or incomplete results: Check that pagination parameters (limit and page) are set correctly and that there are rules available in the FireFly III instance.
Authentication errors: Ensure the API credentials are valid and have sufficient permissions to access the rules endpoint.
Invalid UUID for X-Trace-ID: If provided, ensure the X-Trace-ID is a valid UUID string; otherwise, the API may reject the request.
API rate limits or timeouts: Large result sets or frequent calls might hit API limits; consider adjusting pagination or adding delays.