Skip to content

Search API

All endpoints require authentication. No specific tool permission is required.

GET /api/search

Searches across all major resource types using LIKE matching on titles, names, descriptions, and emails.

Query parameters:

ParamTypeDescription
qstringSearch query (minimum 2 characters)

Response: { results, query }

Results are returned as a flat array ordered by type, with each result containing:

FieldTypeDescription
idstringResource ID
titlestringPrimary display text
subtitlestringSecondary text (varies by type)
typestringResource type
urlstringDeep-link URL

Additional fields may be present depending on the type (e.g. assignee_name, status_label, company_name).

TypeSearched FieldsMax Results
projectname, description8
tasktitle, description (top-level only)8
companyname, industry6
contactfirst_name, last_name, email, job_title6
dealtitle, description6
personname, email, job_title (active users only)6
invoiceinvoice_number, company name6
proposaltitle, company name6
contracttitle6
announcementtitle, content5
pagetitle (non-archived only)6
jobtitle, department, description5
candidatefirst_name, last_name, email5
eventtitle, description5
meetingtitle5
clientcompany name (via client_profiles)6
objectivetitle, description5