GET /leads/search

Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.

Servers

https://api.pipedrive.com/v1

Query parameters

Name	Type	Required	Description
`person_id`	Integer	No	Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
`limit`	Integer	No	Items shown per page
`term`	String	Yes	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`	String	No	A comma-separated string array. The fields to perform the search from. Defaults to all of them. Possible values: `"custom_fields"` `"notes"` `"title"`
`organization_id`	Integer	No	Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
`exact_match`	Boolean	No	When enabled, only full exact matches against the given term are returned. It is not case sensitive.
`start`	Integer	No	Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. Default value: 0
`include_fields`	String	No	Supports including optional fields in the results which are not provided by default Possible values: `"lead.was_seen"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.