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
Categories API → List Categories
AI-generatedOverview
This node operation lists categories from the FireFly III API. It is useful for retrieving a paginated list of all categories available in the user's financial data, which can help in organizing and analyzing expenses or income by category.
Use Case Examples
- Retrieve the first 50 categories to display in a financial dashboard.
- Fetch a specific page of categories to process or analyze category data in bulk.
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 to return) and page (the page number). |
Output
JSON
json- The JSON response containing the list of categories returned by the API.
Dependencies
- Requires an OAuth2 API credential for FireFly III to authenticate requests.
Troubleshooting
- Ensure the OAuth2 credentials are correctly configured and valid to avoid authentication errors.
- If no categories are returned, verify that categories exist in the FireFly III account and that pagination parameters are set correctly.
- Check the X-Trace-ID if provided to trace and debug request issues in the FireFly III API logs.
Links
- FireFly III API Documentation - List Categories - Official API documentation for listing categories in FireFly III.