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 → Get Events
AI-generatedOverview
This node operation retrieves events related to a specific piggy bank using the FireFly III API. It is useful for users who want to track or analyze the history and activities associated with a particular piggy bank, such as deposits, withdrawals, or other changes. For example, a user can fetch all events for a piggy bank to monitor savings progress or audit transactions.
Use Case Examples
- Fetch all events for a piggy bank to review its transaction history.
- Use the events data to generate reports on savings goals and adjustments.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| Piggy Bank ID | The ID of the piggy bank for which events are to be retrieved. |
| Options | Pagination options to limit the number of results and specify the page number. |
Output
JSON
json- The JSON response containing the list of events for the specified piggy bank.
Dependencies
- Requires an API key credential for FireFly III OAuth2 authentication to access the API.
Troubleshooting
- Ensure the Piggy Bank ID is valid and exists in the FireFly III system to avoid 404 errors.
- Check that the API credentials are correctly configured and have the necessary permissions.
- If no events are returned, verify that the piggy bank has recorded events and that pagination parameters are set correctly.
Links
- FireFly III API Documentation - Get Piggy Bank Events - Official API documentation for retrieving events of a piggy bank.