FireFly III icon

FireFly III

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

Actions45

Overview

This node interacts with the "Rules & Groups API" of FireFly III, a personal finance manager. Specifically, the Get Rule Group operation retrieves detailed information about a specific rule group by its ID. Rule groups in FireFly III are collections of rules that automate categorization or processing of transactions.

Typical use cases include:

  • Fetching details of a particular rule group to review or audit its configuration.
  • Integrating rule group data into workflows for reporting or further automation.
  • Using the retrieved rule group info as part of conditional logic in financial automation processes.

Example: You want to get the configuration and metadata of a rule group identified by a unique ID to display it in a dashboard or to verify its settings before triggering related actions.

Properties

Name Meaning
X-Trace-ID A unique UUID string used to trace and debug the request through the API call.
Rule/Group ID The unique identifier (ID) of the rule group you want to retrieve information about. Required.

Output

The output is a JSON object containing the full details of the requested rule group as returned by the FireFly III API. This typically includes properties such as the group's name, description, associated rules, creation date, and other metadata relevant to the rule group.

No binary data is output by this operation.

Example output structure (simplified):

{
  "id": "123",
  "name": "Monthly Expenses Rules",
  "description": "Rules for categorizing monthly expenses",
  "rules": [
    {
      "id": "456",
      "name": "Rent Payment Rule",
      "criteria": "...",
      "actions": "..."
    }
  ],
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-06-01T08:30:00Z"
}

Dependencies

  • Requires an active connection to a FireFly III instance with appropriate API access.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • Optionally supports passing an X-Trace-ID header for request tracing/debugging.

Troubleshooting

  • Missing or invalid Rule/Group ID: The operation requires a valid rule group ID. Ensure the ID is correct and exists in your FireFly III instance.
  • Authentication errors: If the API key or OAuth2 token is missing or invalid, the request will fail. Verify your credentials setup in n8n.
  • Network or connectivity issues: Ensure the FireFly III API endpoint is reachable from your n8n environment.
  • API rate limits or server errors: If the API returns errors due to rate limiting or internal server problems, retry after some time or check the FireFly III server status.
  • Invalid X-Trace-ID format: If provided, the X-Trace-ID should be a valid UUID string; otherwise, the API might reject the request.

Links and References

Discussion