API v1 ReferenceSearch

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>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

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

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

topintegerOptional

Count of top results. Default: 20.

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

Response

OK
totalCountlongOptionalRead-only
The overall number of hits.
maxScoredoubleOptionalRead-only
The highest overall search score.
toplist of any or nullOptional
The best search matches accross all types ordered descending by their score.
commentHitsobjectOptional
companyHitsobjectOptional
dashboardNotesHitsobjectOptional
projectHitsobjectOptional
taskHitsobjectOptional
timeEntriesHitsobjectOptional
timeReportsHitsobjectOptional
userHitsobjectOptional
taskListHitsobjectOptional
fileHitsobjectOptional
documentHitsobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error