Back to PipedriveSearch products
Searches all products by name, code and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope.
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.
fields:
type: string
enum:
- code
- custom_fields
- name
description: >-
A comma-separated string array. The fields to perform the search from.
Defaults to all of them.
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:
- product.price
description: >-
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: searchProductsResponse200
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
properties:
id:
type: integer
description: The ID of the product
type:
type: string
description: The type of the item
name:
type: string
description: The name of the product
code:
type: integer
description: The code of the product
visible_to:
type: integer
description: The visibility of the product
owner:
type: object
properties:
id:
type: integer
description: The ID of the owner of the product
custom_fields:
type: array
description: The custom fields
items:
type: string
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