Skip to navigation

Search assignee candidates (Users, AI Coworkers, Agent Groups)

View as Markdown

Authentication

X-Api-Keystring
API Key authentication via header

Headers

X-Workspace-IdstringOptional

Query parameters

search_keystringOptional>=0 characters
workspace_idlongRequired

Agent groups are always scoped to this workspace. When workspace_members_only is true (default), users and AI coworkers are also restricted to members of this workspace. AI coworkers are only returned when the AI_WORKERS feature flag is enabled for the tenant.

workspace_members_onlybooleanOptionalDefaults to true

When true (default), user and AI coworker candidates are restricted to members of the given workspace — use for private notes. When false, users and AI coworkers are searched tenant-wide — use for public replies. Agent groups are always workspace-scoped regardless of this value.

limitintegerOptional1-100Defaults to 10

Max results returned per assignee type (not a combined total). Up to limit users and limit agent groups are always returned; up to limit AI coworkers are returned only when the AI_WORKERS feature flag is enabled. Defaults to 10.

Response

Successful response