Back to PipedrivePerform a search from multiple item types
Performs a search from your choice of item types and fields.
Input
type: object
properties:
parameters:
type: object
properties:
term:
type: string
description: >-
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:
type: string
enum:
- deal
- person
- organization
- product
- lead
- file
- mail_attachment
- project
description: >-
A comma-separated string array. The type of items to perform the
search from. Defaults to all.
fields:
type: string
enum:
- address
- code
- custom_fields
- email
- name
- notes
- organization_name
- person_name
- phone
- title
- description
description: >-
A comma-separated string array. The fields to perform the search from.
Defaults to all. Relevant for each item type are:<br> <table>
<tr><th><b>Item type</b></th><th><b>Field</b></th></tr>
<tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr>
<tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`,
`phone`</td></tr> <tr><td>Organization</td><td>`address`,
`custom_fields`, `name`, `notes`</td></tr>
<tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr>
<tr><td>Lead</td><td>`custom_fields`, `notes`, `email`,
`organization_name`, `person_name`, `phone`, `title`</td></tr>
<tr><td>File</td><td>`name`</td></tr> <tr><td>Mail
attachment</td><td>`name`</td></tr> <tr><td>Project</td><td>
`custom_fields`, `notes`, `title`, `description` </td></tr> </table>
<br> 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`.
search_for_related_items:
type: boolean
enum:
- true
- false
description: >-
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:
type: boolean
enum:
- true
- false
description: >-
When enabled, only full exact matches against the given term are
returned. It is <b>not</b> case sensitive.
include_fields:
type: string
enum:
- deal.cc_email
- person.picture
- product.price
description: >-
A comma-separated string array. Supports including optional fields in
the results which are not provided by default.
start:
type: integer
default: 0
description: >-
Pagination start. Note that the pagination is based on main results
and does not include related items when using
`search_for_related_items` parameter.
limit:
type: integer
description: Items shown per page
required:
- term
Output
title: searchItemResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
type: object
properties:
items:
type: array
description: The array of found items
items:
type: object
properties:
result_score:
type: number
description: Search result relevancy
item:
type: object
description: Item
related_items:
type: array
description: The array of related items if `search_for_related_items` was enabled
items:
type: object
properties:
result_score:
type: number
description: Search result relevancy
item:
type: object
description: Item
additional_data:
type: object
properties:
pagination:
description: Pagination details of the list
type: object
properties:
start:
type: integer
description: Pagination start
limit:
type: integer
description: Items shown per page
more_items_in_collection:
type: boolean
description: Whether there are more list items in the collection than displayed
next_start:
type: integer
description: Next pagination start