users.find: Find users by name

Description Usage Arguments Value Examples

Description

Function to Find users by name from pipedrive.

Usage

1
2
users.find(term, search_by_email = NULL, api_token = NULL,
  company_domain = "api")

Arguments

term

Search term to look for

search_by_email

When enabled, term will only be matched against email addresses of users. 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

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

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