ItemSearch
Ordered reference objects, pointing to either deals, persons, organizations, leads, products, files or mail attachments.
Perform a search from multiple item types
Performs a search from your choice of item types and fields.
Request
/api/v2/itemSearch
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
limit
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
cursor
string
For pagination, the marker (an opaque string value) representing the first item on the next page
Response
OK
Expand all
Copy code- true
- { ... }▶
- { ... }▶
Perform a search using a specific field from an item type
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).
Request
/api/v2/itemSearch/field
Query parameters
term
string
required
The search term to look for. Minimum 2 characters (or 1 if match is exact). Please note that the search term has to be URL encoded.
entity_type
string
required
The type of the field to perform the search from
Values
deal
lead
person
organization
product
project
match
string
The type of match used against the term. The search is case sensitive.
E.g. in case of searching for a value monkey,
- with
exactmatch, you will only find it if term ismonkey - with
beginningmatch, you will only find it if the term matches the beginning or the whole string, e.g.monkandmonkey - with
middlematch, you will find the it if the term matches any substring of the value, e.g.onkandke
Default
exact
Values
exact
beginning
middle
field
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.
limit
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
cursor
string
For pagination, the marker (an opaque string value) representing the first item on the next page
Response
OK
Expand allCopy code- true
- [ ... ]▶
- { ... }▶