Search cases and files
Search
Search Cases and Files
Perform full-text search across all cases and files accessible to you.
GET
Search cases and files
Perform a comprehensive search across all cases and files accessible to you. This endpoint allows you to find matching case labels and file names, providing a unified search experience for your document workflows.
Features
- Prefix Matching: Search results include partial matches (e.g., “pol” matches “policy”).
- Unified Results: Matches against both case labels and file names.
- Flat Output: Returns a flat list of files with their parent case context for easy display.
Best Practices
- Debounce UI Searches: If implementing search-as-you-type in your frontend, debounce requests (e.g., 300ms) to avoid hitting rate limits.
- Specific Queries: More specific search terms yield more relevant results and improve performance.
- Pagination: Use
limitandoffsetfor large result sets to maintain responsive UI performance.
Authorizations
Query Parameters
Required string length:
1 - 100Maximum number of results to return
Required range:
1 <= x <= 100Number of results to skip for pagination
Required range:
0 <= x <= 9007199254740991