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
General → Search All API
AI-generatedOverview
This node operation performs a search query across different entity types in the FireFly III API, specifically for 'Transactions' or 'Accounts'. It allows users to search for entities by a query string with optional filters such as account type and search field for accounts, and supports pagination options to limit and page through results. This is useful for scenarios where users want to quickly find specific transactions or accounts matching certain criteria within their financial data managed by FireFly III.
Use Case Examples
- Search all transactions containing a specific keyword or phrase.
- Search accounts filtered by account type (e.g., asset, cash) and specific fields like IBAN or account number.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| Search For | The type of entity to search, either 'Transactions' or 'Accounts'. |
| Query | The search query string to find matching entities. |
| Account Type | Filter accounts by their type when searching accounts. |
| Field | The account field(s) to search in when searching accounts. |
| Pagination Options | Options to control pagination of search results, including limit and page number. |
Output
JSON
json- The JSON response containing the search results from the FireFly III API for the specified entity type and query.
Dependencies
- FireFly III API with OAuth2 authentication
Troubleshooting
- Ensure the query string is not empty as it is required for the search operation.
- Verify that the 'Search For' option is correctly set to either 'Transactions' or 'Accounts' to avoid invalid endpoint errors.
- Check that pagination parameters (limit and page) are positive integers to prevent request errors.
- If filtering by account type or field, ensure the values are valid as per the API documentation to avoid empty or incorrect results.
- Use the X-Trace-ID for debugging and tracing requests if the API returns errors or unexpected results.
Links
- FireFly III API Documentation - Official API documentation site for FireFly III.
- Intro to Search - Overview of search features in FireFly III.
- Full Search Options Reference - Detailed reference for search options in FireFly III.