provider Leads GET /leads/search
@utdk/pipedrive /leads/search
Search leads
Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
term query 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.
string
fields query
A comma-separated string array. The fields to perform the search from. Defaults to all of them.
enum: custom_fields, notes, title
exact_match query
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
boolean
person_id query
Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
integer
organization_id query
Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
integer
include_fields query
Supports including optional fields in the results which are not provided by default
enum: lead.was_seen
start query
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
integer
limit query
Items shown per page
integer

Try it

Authentication
Configure credentials for Pipedrive API v1
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

searchleads
GET/leads/search
Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.

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.

A comma-separated string array. The fields to perform the search from. Defaults to all of them.

When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.

Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.

Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.

Supports including optional fields in the results which are not provided by default

Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.

Items shown per page

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import pipedrive from '@utdk/pipedrive';

await pipedrive.searchleads({
  "start": 0
})