client.searchOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/searchsearch.query
Searches only the requested, scope-authorized product domains in the owning cell. Results are bounded, metadata-only, tenant-filtered and sharing-filtered. meta.search.complete is always false: even a short or empty index result does not prove completeness. Narrow ambiguous searches or use resource list pagination for complete reports. Verify recent writes by their returned IDs because indexing can lag.
client.search.query(data: SearchQuery, options: RequestOptions = {})- Return form
Promise- Operation ID
searchResources- Required scopes
search:read- Conditional scopes
contacts:readprojects:readtasks:read- SDK parameters
data: SearchQueryoptions: RequestOptions- Header request fields
X-TeamGrid-Response-Features?: string- Request body
SearchRequestapplication/json- Success
200 Array<SearchResult> envelope
Errors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.