Returns grouped, permission-filtered candidates for Assign editor
mentions and references. Matching is prefix-and-word based across
active member display names, active Workspace Agent names, unarchived
Document titles, unarchived Project names and keys, and unarchived Task
titles and ticket references. Each requested type is independently limited; no cursor
or total is exposed. A blank query returns an empty result.
Path Parameters
workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
Query Parameters
qRequired
string·min 0·max 100
Typeahead text. Leading and trailing whitespace is ignored; blank text returns no candidates.
types
string[]
Repeat to restrict result groups. Omitting it queries all five types.
Values
useragentdocumentprojecttask
limit
integer·min 1·max 20·default 10
Maximum candidates returned for each requested type. Defaults to 10.
surface
string·default comment
Comment (default) requires Agent Task-comment capability. Discuss includes ready installed Agents and active custom Agents without that capability; entitlement and Project or binding visibility still apply. Selection never grants execution authority.
Values
commentdiscuss
Responses
usersRequired
object[]·max 20
agentsRequired
object[]·max 20
documentsRequired
object[]·max 20
projectsRequired
object[]·max 20
tasksRequired
object[]·max 20
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Retry-After
integer·min 0
Delay in seconds before retrying, when an expected maintenance end is known.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
