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
Accounts API → Get Piggy Banks
AI-generatedOverview
This node operation retrieves piggy banks associated with a specific account using the FireFly III API. It is useful for users who want to manage or view savings goals linked to their accounts. For example, a user can fetch all piggy banks for a given account to display savings progress or to analyze financial goals.
Use Case Examples
- Fetch all piggy banks for a user's savings account to display in a dashboard.
- Retrieve piggy banks linked to an account to automate notifications when a savings goal is reached.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| Account ID | The ID of the account for which piggy banks are to be retrieved. |
| Pagination Options | Options to control pagination of the results, including limit (max number of results) and page number. |
Output
JSON
json- The JSON response containing the list of piggy banks associated with the specified account.
Dependencies
- Requires an OAuth2 API credential for FireFly III to authenticate API requests.
Troubleshooting
- Ensure the Account ID is provided and valid; missing or incorrect ID will cause the API request to fail.
- Check the X-Trace-ID if debugging is needed to trace the request in logs.
- Pagination parameters should be positive integers; invalid values may cause errors or unexpected results.
- API authentication must be correctly configured; otherwise, requests will be unauthorized.
Links
- FireFly III API Documentation - Get Piggy Banks - Official API documentation for retrieving piggy banks by account.