persons.find: Find persons by name

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

Description

Function to Find persons by name from pipedrive.

Usage

persons.find(term, org_id = NULL, start = NULL, limit = NULL,
  search_by_email = NULL, api_token = NULL, company_domain = "api")

Arguments

term	Search term to look for
org_id	ID of the organization person is associated with.
start	Pagination start
limit	Items shown per page
search_by_email	When enabled, term will only be matched against email addresses of people. Default: false 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

persons.find(term='e.g.',api_token='token',company_domain='exp')

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