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, specifically supporting the operation to List Rule Groups. It retrieves a paginated list of rule groups defined in the FireFly III system.

Use cases include:

  • Fetching all rule groups for auditing or management purposes.
  • Integrating rule group data into workflows for automation or reporting.
  • Synchronizing rule groups with other systems or databases.

For example, you might use this node to get the first 50 rule groups and then process them further in your workflow.

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 is a JSON object containing the list of rule groups returned by the FireFly III API. The structure typically includes metadata about pagination and an array of rule group objects with their details.

Example output structure (simplified):

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "created_at": "string",
      "updated_at": "string"
      // ... other rule group properties
    }
    // ... more rule groups
  ],
  "meta": {
    "pagination": {
      "total": 100,
      "count": 50,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 2
    }
  }
}

No binary data output is produced by this operation.

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.
  • The node uses HTTP GET requests to the /rule-groups endpoint with optional query parameters for pagination.

Troubleshooting

  • Empty or missing results: Ensure that the FireFly III instance has rule groups created. Also verify pagination parameters are correct.
  • Authentication errors: Confirm that the API key or OAuth2 token is valid and has sufficient permissions.
  • Invalid UUID in X-Trace-ID: If using the X-Trace-ID property, ensure it is a valid UUID format; otherwise, the server may reject the request.
  • API rate limits or timeouts: Large result sets or frequent calls may hit API limits; adjust pagination or add delays as needed.
  • Unexpected response structure: Verify that the FireFly III API version matches the expected schema.

Links and References

Discussion