Search persons
GET {{baseUrl}}/persons/search?term=<string>&fields=<string>&exact_match=<boolean>&organization_id=<integer>&include_fields=<string>&limit=<integer>&cursor=<string>
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
term | string | (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 | string | A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>. | |
exact_match | string | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | |
organization_id | string | Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000. | |
include_fields | string | Supports including optional fields in the results which are not provided by default | |
limit | string | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. | |
cursor | string | For pagination, the marker (an opaque string value) representing the first item on the next page |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":{"items":[{"result_score":0.5092,"item":{"id":1,"type":"person","name":"Jane Doe","phones":["+372 555555555"],"emails":["jane@pipedrive.com"],"visible_to":3,"owner":{"id":1},"organization":{"id":1,"name":"Organization name","address":null},"custom_fields":[],"notes":[]}}]},"additional_data":{"next_cursor":"eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"}}