Search persons
The Pipedrive Search Persons tool enables efficient and precise searching of contacts within the Pipedrive CRM using various fields like name, email, phone, notes, or custom attributes. It enhances data retrieval by allowing filters such as Organization ID and exact match options, streamlining the process of finding the right person records.
Features
- Search across multiple fields including name, email, phone, notes, and custom fields for comprehensive person lookup.
- Supports filtering search results by Organization ID to narrow down relevant contacts.
- Allows exact match searching to return precise person records without partial matches.
- Pagination support with customizable start and limit parameters for managing large datasets.
- Option to include additional fields like person picture to enrich search results.
Benefits
- Saves time by quickly locating specific contacts in large CRM databases.
- Improves data accuracy with exact match and multiple field search options.
- Enhances CRM data management by filtering contacts based on organizational relationships.
- Supports scalable searches with pagination, ideal for businesses with extensive contact lists.
- Enriches contact profiles by including optional data like profile pictures for better user experience.
Description
Searches all Persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found Persons can be filtered by Organization ID. See the Pipedrive API docs here
IMPORTANT: The arguments have specific formats. Please follow the instructions below:
- fields: Return JSON in this format: string[]
Parameters
7 parameters
| Name | Type | Description |
|---|---|---|
| termrequired | string | The search term to look for. Minimum 2 characters (or 1 if using exact_match). |
| fields | string[] | An array containing fields to perform the search from. Defaults to all of them. |
| exactMatch | boolean | When enabled, only full exact matches against the given term are returned. It is not case sensitive. |
| organizationId | integer | Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000. |
| includeFields | enum | Supports including optional fields in the results which are not provided by default. |
| start | integer | Pagination start. Note that the pagination is based on main results and does not include related items when using |
| limit | integer | Items shown per page. |
