search

Performs a full-text search across workspace entities.

Changed on

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

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/search
  • Auth: HTTP bearer

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, thread. Users without the PM product can search only project, user, document and thread. Users without the AI product cannot search thread. Other types give no results. Thread results contain only AI threads that the user can open.

topinteger

Count of top results. Default: 20. Must be between 1 and the configured maximum (SearchMaximumResults).

includeClosedAndStuckboolean

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

Response

OK

totalCountinteger

The overall number of hits.

maxScorenumber double

The highest overall search score.

Changes