SEARCH
Documentation
SEARCH
What is it for?
SEARCH provides a global search across all modules and areas of your tenant. It searches data from other active plugins and displays the results in a unified overview.
You can use it to:
- Search tenants, contracts, inventory, tickets, and more
- Quickly jump to any menu item via navigation search
- Filter results to a specific area using
@provider
How does the search work?
Search page /search
1. Open Search in the menu or go to /search.
2. Enter your search term – results appear instantly.
3. Navigate with arrow keys and open a result with Enter.
Filter with @
You can narrow down the search to a specific area:
@mieter searchterm– search only in tenants@vertrag searchterm– search only in contracts@inventar searchterm– search only in inventory@ticket searchterm– search only in tickets
Type @ followed by the area name – a dropdown shows the available filters. Press Tab to accept the filter suggestion.
Keyboard shortcuts
@– Open filter menuTab– Accept filter suggestionArrow keys– Navigate resultsEnter– Open selected resultEsc– Close window
Which areas are searched?
Depending on which plugins are active, the following areas are searched:
| Area | Description |
|---|---|
| Navigation | Menu items and settings (always available) |
| Tenants | Tenants by name, email or phone |
| Landlords | Landlords by name |
| Contracts | Contracts by name or details |
| Inventory | Inventory items |
| Tickets | Ticket plugin entries |
| Calendar | Calendar entries |
| Freizeit | Events, participants, lists, pack lists, shopping lists, tents |
| Statistics | Statistics data |
| Cafe | Cafe plugin entries |
| CMS | CMS pages |
Technical URLs (Quick reference)
GET /search– Search page (Command Palette)GET /search/api?q={term}&limit={count}– JSON API for searchGET /search/api/providers– List of all available search providers
Notes
- The search only searches data from activated plugins.
- The API returns a maximum of 50 results (default: 20).
- The order of results is determined by the priority of each search provider.
- The search can also be started via the search bar in the sidebar.