Sign in
search

Performs a full-text search across workspace entities.

This endpoint enables powerful full-text search capabilities across multiple types. It returns a ranked list of matching entities based on relevance and respects user permissions.

         The search functionality includes:
         - Cross-entity search across various entity types in the workspace.
         - Relevance-based scoring and ranking of results.
         - Respecting user access permissions for all returned results.
         - Customizable result filtering by entity type and status.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

get/search

Query parameters

searchTermstring

The term to search for. Max. 50 characters. Required.

searchTypesstring

Comma-separated list of types to search for, or 'all'. Supported types: task, project, user, company, comment, timeentry, timereport, file, document, tasklist, dashboardnote.

topinteger

Count of top results. Default: 20.

includeClosedAndStuckboolean

If true, the result will include entities where the status is closed, stuck and done.

Headers

Authorizationstring required

Bearer authentication

Response

OK

totalCountinteger

The overall number of hits.

maxScorenumber double

The highest overall search score.

Changes

No recorded changes to this endpoint across all 5 revisions of this API.