get
/search.json
Search for a given text in the entities, matching entities are returned by the most relevant first.
The following values are allowed in the include query parameter:
- company.avatar
- company.phoneNumbers.code
- company.timezone
- contacts.avatar
- contacts.company
- contacts.phoneNumbers.code
- contacts.timezone
- createdBy.avatar
- currency
- customFieldEntities.avatar
- lostReason
- wonReason
- mainContact.avatar
- mainContact.timezone
- owner.avatar
- products
- stage.pipeline
The following targets are allowed in filter query parameters:
- isQualified
- kind
- pipelineId
In the response, title is a string that represents the content entity, as follows:
| “content” type | Property / properties |
|---|---|
| activities | title |
| companies | name |
| contacts | firstName + lastName |
| deals | title |
| files | name |
| notes | description |
| pipelines | name |
| products | name |
| users | firstName + lastName |
If the title is longer than 255 characters, it’s truncated to 251 characters and “…” is appended.
Request Parameters
4 Query Parameters
Responses
200 OK
Schema
included
object
Included contains all the side-loaded data of a response. See including related entities.
meta
object
ResponseMeta contains common meta data.
searchResults
array[object]
Send a Test Request
GET
Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host