Search API
All endpoints require authentication. No specific tool permission is required.
Global Search
Section titled “Global Search”GET /api/searchSearches across all major resource types using LIKE matching on titles, names, descriptions, and emails.
Query parameters:
| Param | Type | Description |
|---|---|---|
q | string | Search query (minimum 2 characters) |
Response: { results, query }
Results are returned as a flat array ordered by type, with each result containing:
| Field | Type | Description |
|---|---|---|
id | string | Resource ID |
title | string | Primary display text |
subtitle | string | Secondary text (varies by type) |
type | string | Resource type |
url | string | Deep-link URL |
Additional fields may be present depending on the type (e.g. assignee_name, status_label, company_name).
Searched Resource Types
Section titled “Searched Resource Types”| Type | Searched Fields | Max Results |
|---|---|---|
project | name, description | 8 |
task | title, description (top-level only) | 8 |
company | name, industry | 6 |
contact | first_name, last_name, email, job_title | 6 |
deal | title, description | 6 |
person | name, email, job_title (active users only) | 6 |
invoice | invoice_number, company name | 6 |
proposal | title, company name | 6 |
contract | title | 6 |
announcement | title, content | 5 |
page | title (non-archived only) | 6 |
job | title, department, description | 5 |
candidate | first_name, last_name, email | 5 |
event | title, description | 5 |
meeting | title | 5 |
client | company name (via client_profiles) | 6 |
objective | title, description | 5 |