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
Object Groups API → Get Piggy Banks
AI-generatedOverview
This node operation retrieves piggy banks associated with a specific object group in the FireFly III API. It is useful for users who want to manage or analyze savings goals or piggy banks grouped under a particular object group. For example, a user can fetch all piggy banks linked to a project or category represented by an object group to monitor savings progress or perform financial planning.
Use Case Examples
- Retrieve all piggy banks linked to an object group representing a specific financial goal or project.
- Fetch piggy banks for an object group to display savings data in a dashboard.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| Object Group ID | The ID of the object group whose piggy banks are to be retrieved. |
| Pagination Options | Options to control pagination of results, including limit (max number of results) and page number to retrieve. |
Output
JSON
json- The JSON response containing the list of piggy banks associated with the specified object group, including pagination details if applicable.
Dependencies
- Requires an API key credential for FireFly III OAuth2 authentication to access the FireFly III API.
Troubleshooting
- Ensure the Object Group ID is valid and exists in the FireFly III system; otherwise, the API will return an error or empty result.
- Check that the X-Trace-ID, if provided, is a valid UUID format to avoid request tracing issues.
- Verify pagination parameters (limit and page) are positive integers to prevent invalid request errors.
Links
- FireFly III API Documentation - Get Piggy Banks for Object Group - Official API documentation for retrieving piggy banks associated with an object group.