Perform a search using a specific field from an item type
GET {{baseUrl}}/itemSearch/field?term=<string>&entity_type=<string>&match=exact&field=<string>&limit=<integer>&cursor=<string>
Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
term | string | (Required) The search term to look for. Minimum 2 characters (or 1 if match is exact). Please note that the search term has to be URL encoded. | |
entity_type | string | (Required) The type of the field to perform the search from | |
match | string | The type of match used against the term. The search <b>is</b> case sensitive.<br/><br/> E.g. in case of searching for a value monkey, <ul> <li>with exact match, you will only find it if term is monkey</li> <li>with beginning match, you will only find it if the term matches the beginning or the whole string, e.g. monk and monkey</li> <li>with middle match, you will find the it if the term matches any substring of the value, e.g. onk and ke</li> </ul>. | |
field | string | (Required) The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.). 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>. | |
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":[{"id":1,"name":"Jane Doe"},{"id":2,"name":"John Doe"}],"additional_data":{"next_cursor":"eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"}}