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
Budgets API → List Budgets
AI-generatedOverview
This node operation lists budgets from the FireFly III API. It supports filtering the budgets by date range and pagination options such as limit and page number. This is useful for users who want to retrieve a list of their budgets with control over the number of results and filtering by specific time periods.
Use Case Examples
- Retrieve a list of budgets created between January 1, 2025, and December 31, 2025, limited to 50 results per page.
- Fetch the second page of budgets with a maximum of 20 budgets per page.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| Date Range Filters | Filters to specify the start and end dates for filtering budgets (format YYYY-MM-DD). |
| Pagination Options | Options to control pagination of the results, including limit and page number. |
Output
JSON
json- The JSON response containing the list of budgets retrieved from the FireFly III API.
Dependencies
- FireFly III API with OAuth2 authentication
Troubleshooting
- Ensure that the start and end dates in the date range filters are in the correct YYYY-MM-DD format to avoid API errors.
- If pagination options are set incorrectly (e.g., limit less than 1 or page less than 1), the API may return errors or unexpected results.
- The API requires a valid OAuth2 credential; ensure the credential is correctly configured and authorized.
Links
- FireFly III Budgets API Documentation - Official API documentation for listing budgets in FireFly III.