v1

latestOpenAPI 3.0.12026-08-0621301.7 MB
Leads

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.

get/leads/search

Query parameters

termstring 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.

fields'custom_fields' | 'notes' | 'title'

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

exact_matchboolean

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

person_idinteger

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

organization_idinteger

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

include_fields'lead.was_seen'

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

startinteger

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

limitinteger

Items shown per page

Response

Success

successboolean

If the response is successful or not