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
Piggy Banks API → List Piggy Banks
AI-generatedOverview
This node interacts with the FireFly III API to list piggy banks. It retrieves a paginated list of piggy banks, allowing users to specify pagination options such as the number of results per page and the page number. This is useful for managing and viewing savings goals or piggy banks within the FireFly III financial management system.
Use Case Examples
- Retrieve the first 50 piggy banks to display in a dashboard.
- Fetch a specific page of piggy banks when dealing with a large number of savings goals.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| Options | Pagination options to control the number of results and the page number. |
Output
JSON
json- The JSON response from the FireFly III API containing the list of piggy banks.
Dependencies
- FireFly III API
- An API key credential for authentication
Troubleshooting
- Ensure the API credentials are correctly configured to avoid authentication errors.
- Verify that the pagination parameters (limit and page) are within valid ranges to prevent request errors.
- If the API returns an error, check the X-Trace-ID for debugging and tracing the request.
Links
- FireFly III Piggy Banks API Documentation - Official documentation for the Piggy Banks API endpoints.