ItemSearch
Ordered reference objects, pointing to either deals, persons, organizations, leads, products, files or mail attachments.
Perform a search from multiple item types
/v1/itemSearch
Performs a search from your choice of item types and fields.
Query parameters
term
string
required
The search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded.
item_types
string
A comma-separated string array. The type of items to perform the search from. Defaults to all.
Values
deal
person
organization
product
lead
file
mail_attachment
project
fields
string
A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:
| Item type | Field |
|---|---|
| Deal | custom_fields, notes, title |
| Person | custom_fields, email, name, notes, phone |
| Organization | address, custom_fields, name, notes |
| Product | code, custom_fields, name |
| Lead | custom_fields, notes, email, organization_name, person_name, phone, title |
| File | name |
| Mail attachment | name |
| Project | custom_fields, notes, title, description |
Only the following custom field types are searchable:
address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields here.When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use
search_for_related_items.
Values
address
code
custom_fields
name
notes
organization_name
person_name
phone
title
description
search_for_related_items
boolean
When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
exact_match
boolean
When enabled, only full exact matches against the given term are returned. It is not case sensitive.
include_fields
string
A comma-separated string array. Supports including optional fields in the results which are not provided by default.
Values
deal.cc_email
person.picture
product.price
start
integer
Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.
Default
0
limit
integer
Items shown per page
Response
OK
Expand all
Copy code- true
- { ... }▶
- { ... }▶
Perform a search using a specific field from an item type
/v1/itemSearch/field
Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
Query parameters
term
string
required
The search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded.
field_type
string
required
The type of the field to perform the search from
Values
dealField
leadField
personField
organizationField
productField
projectField
exact_match
boolean
When enabled, only full exact matches against the given term are returned. The search is case sensitive.
field_key
string
required
The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields here.
return_item_ids
boolean
Whether to return the IDs of the matching items or not. When not set or set to 0 or false, only distinct values of the searched field are returned. When set to 1 or true, the ID of each found item is returned.
start
integer
Pagination start
limit
integer
Items shown per page
Response
OK
Expand allCopy code- true
- [ ... ]▶
- { ... }▶
