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
Recurrences API → List Recurrences
AI-generatedOverview
This node operation lists recurring transactions using the FireFly III API. It is useful for retrieving a paginated list of all recurring transactions set up in the user's FireFly III account. For example, a user can fetch recurring bills or scheduled payments to monitor or manage them programmatically.
Use Case Examples
- Retrieve the first page of recurring transactions with a limit of 50 results per page.
- Fetch the second page of recurring transactions with a custom limit to review scheduled transactions.
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 the maximum number of results to return and the page number to retrieve. |
Output
JSON
json- The JSON response containing the list of recurrences returned by the FireFly III API.
Dependencies
- Requires an OAuth2 API credential for FireFly III to authenticate API requests.
Troubleshooting
- Ensure the OAuth2 credentials are correctly configured and valid to avoid authentication errors.
- Verify that the pagination parameters (limit and page) are positive integers to prevent request errors.
- If the API returns an error, check the X-Trace-ID for debugging and tracing the request in the FireFly III system.
Links
- FireFly III API Documentation - List Recurrences - Official API documentation for listing recurrences in FireFly III.