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.
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- 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.