SearchResults

Ordered reference objects, pointing to either Deals, Persons, Organizations, Files or Products.

Perform a search using a specific field value

Copy link
Copy to clipboard
GET

/v1/searchResults/field

Deprecated endpoint

This endpoint is deprecated. Please use /v1/itemSearch/field instead.
Performs a search from a specific field's values. Results can be either the distinct values of the field (useful for searching autocomplete field values), or actual items IDs (deals, persons, organizations or products).

Query parameters

term

string

required

Search term to look for, minimum 2 characters.

exact_match

number

When enabled, only full exact matches against the given term are returned. By default, term can be present anywhere in the resulting field values to be considered a match. The minimum 2 character limit for the term is discarded when exact_match is enabled.

Values

0

1

field_type

string

required

Type of the field to perform the search from.

Values

dealField

personField

organizationField

productField

field_key

string

required

Key of the field to search from. Field key can be obtained by fetching the list of fields using any of fields API GET methods (dealFields, personFields, ..).

return_field_key

string

Name of the field in search results from which the search was performed. When omitted, 'value' will be used. You may want to set this parameter to match the field_key.

return_item_ids

number

Whether to return matching items IDs in search results. When omitted or set to 0, only distinct values of the searched field are returned. When enabled, the return_field_key parameter is ignored and the results include the searched field as its own key.

Values

0

1

start

integer

Pagination start

Default

0

limit

integer

Items shown per page

Response
200

success

Subscribe to Pipedrive’s Developer Newsletter