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
Required Permissions
Any authenticated user.

Headers

AuthorizationstringRequired

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

Query parameters

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

Comma-separated list of types to search for, or ‘all’. Default: all types.

topintegerOptional

Count of top results. Default: 20.

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

Response

OK
totalCountlong or null
The overall number of hits.
maxScoredouble or null
The highest overall search score.
toplist of any or null
The best search matches accross all types ordered descending by their score.
commentHitsobject or null
companyHitsobject or null
dashboardNotesHitsobject or null
projectHitsobject or null
taskHitsobject or null
timeEntriesHitsobject or null
timeReportsHitsobject or null
userHitsobject or null
taskListHitsobject or null
fileHitsobject or null
documentHitsobject or null

Errors