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 → List Object Groups
AI-generatedOverview
This node operation lists object groups from the FireFly III API. Object groups are collections that are automatically created when bills or piggy banks are associated with a group using specific parameters. This operation is useful for retrieving and managing these groups, especially when you want to view or paginate through existing object groups.
Use Case Examples
- Retrieve a paginated list of object groups to display in a dashboard.
- Fetch object groups to analyze associations with bills or piggy banks.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| Pagination Options | Options to control pagination of the results, including limit (max number of results) and page (page number to retrieve). |
Output
JSON
json- The JSON response containing the list of object groups retrieved from the API.
Dependencies
- Requires an API key credential for FireFly III OAuth2 authentication.
Troubleshooting
- Ensure the API credentials are correctly configured and valid to avoid authentication errors.
- If no object groups are returned, verify that bills or piggy banks have been associated with object groups, as they cannot be created directly.
- Check the X-Trace-ID for debugging if the API request fails or returns unexpected results.
Links
- FireFly III API Documentation - List Object Groups - Official API documentation for listing object groups in FireFly III.