searchresults.get: Perform a search

In Rpipedrive: 'Pipedrive API's' Functions to Improvement and Integration's Systems

Description

Function to Perform a search from pipedrive.

Usage

searchresults.get(term, item_type = NULL, start = NULL, limit = NULL,
  exact_match = NULL, api_token = NULL, company_domain = "api")

Arguments

term	Search term to look for, minimum 2 characters.
item_type	Search for items of exact type. If omitted, all types of items are searched. This field has the following domains: (deal; person; organization; product; file)
start	Pagination start
limit	Items shown per page
exact_match	When enabled, only full exact matches against the given term are returned. The minimum 2 character limit for the term is discarded when exact_match is enabled. It will only work if search term is 30 characters or less. This field has the following domains: (0; 1)
api_token	To validate your requests, you'll need your api_token - this means that our system will need to know who you are and be able to connect all actions you do with your chosen Pipedrive account. Have in mind that a user has a different api_token for each company. Please access the following link for more information: <https://pipedrive.readme.io/docs/how-to-find-the-api-token?utm_source=api_reference>
company_domain	How to get the company domain: <https://pipedrive.readme.io/docs/how-to-get-the-company-domain>

Value

return an object List()

Examples

searchresults.get(term='e.g.',api_token='token',company_domain='exp')

Rpipedrive documentation built on May 15, 2019, 1:06 a.m.