Actions89
- General Actions
- About API Actions
- Accounts API Actions
- Available Budgets API Actions
- Bills API Actions
- Budgets API Actions
- Transactions API Actions
- Categories API Actions
- Tags API Actions
- Rules & Groups API Actions
- Piggy Banks API Actions
- Object Groups API Actions
- Recurrences API Actions
Rules & Groups API → List Rules
AI-generatedOverview
This node operation lists rules from the FireFly III Rules & Groups API. It is useful for retrieving a paginated list of rules that have been defined in the FireFly III system, which can be used for automating transaction categorization or other financial rules management.
Use Case Examples
- Retrieve a list of all rules with pagination to display in a dashboard.
- Fetch rules to analyze or modify them programmatically in an automation workflow.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| Pagination Options | Options to control pagination of the results, including limit (max number of results) and page (page number to retrieve). |
Output
JSON
json- The JSON response containing the list of rules retrieved from the FireFly III API.
Dependencies
- Requires an OAuth2 API credential for FireFly III to authenticate requests.
Troubleshooting
- Ensure the OAuth2 credentials are correctly configured and valid to avoid authentication errors.
- If the API returns an empty list, verify that rules exist in the FireFly III instance and that pagination parameters are set correctly.
- Check the X-Trace-ID if provided to trace and debug requests in the FireFly III system logs.
Links
- FireFly III API Documentation - List Rules - Official API documentation for listing rules in the FireFly III Rules & Groups API.