Find users by name

GET {{baseUrl}}/users/find?term=<string>&search_by_email=0

Finds users by their name.

Request Params

KeyDatatypeRequiredDescription
termstring(Required) The search term to look for
search_by_emailnumberWhen enabled, the term will only be matched against email addresses of users. Default: false.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;success&quot;:true,&quot;data&quot;:[{&quot;id&quot;:1,&quot;name&quot;:&quot;John Doe&quot;,&quot;default_currency&quot;:&quot;EUR&quot;,&quot;locale&quot;:&quot;et_EE&quot;,&quot;lang&quot;:1,&quot;email&quot;:&quot;john@pipedrive.com&quot;,&quot;phone&quot;:&quot;0000-0001&quot;,&quot;activated&quot;:true,&quot;last_login&quot;:&quot;2019-11-21 08:45:56&quot;,&quot;created&quot;:&quot;2018-11-13 09:16:26&quot;,&quot;modified&quot;:&quot;2019-11-21 08:45:56&quot;,&quot;has_created_company&quot;:true,&quot;access&quot;:[{&quot;app&quot;:&quot;sales&quot;,&quot;admin&quot;:true,&quot;permission_set_id&quot;:&quot;62cc4d7f-4038-4352-abf3-a8c1c822b631&quot;},{&quot;app&quot;:&quot;global&quot;,&quot;admin&quot;:true,&quot;permission_set_id&quot;:&quot;233b7976-39bd-43a9-b305-ef3a2b0998e5&quot;},{&quot;app&quot;:&quot;account_settings&quot;,&quot;admin&quot;:true,&quot;permission_set_id&quot;:&quot;982c5ce5-b8ba-4b47-b102-9da024f4b990&quot;}],&quot;active_flag&quot;:true,&quot;timezone_name&quot;:&quot;Europe/Berlin&quot;,&quot;timezone_offset&quot;:&quot;+03:00&quot;,&quot;role_id&quot;:1,&quot;icon_url&quot;:&quot;https://upload.wikimedia.org/wikipedia/en/thumb/e/e0/WPVG_icon_2016.svg/1024px-WPVG_icon_2016.svg.png&quot;,&quot;is_you&quot;:true,&quot;is_deleted&quot;:false},{&quot;id&quot;:2,&quot;name&quot;:&quot;Jane Doe&quot;,&quot;default_currency&quot;:&quot;EUR&quot;,&quot;locale&quot;:&quot;et_EE&quot;,&quot;lang&quot;:1,&quot;email&quot;:&quot;jane@pipedrive.com&quot;,&quot;phone&quot;:&quot;0000-0002&quot;,&quot;activated&quot;:true,&quot;last_login&quot;:&quot;2019-09-11 11:43:54&quot;,&quot;created&quot;:&quot;2019-01-22 10:43:47&quot;,&quot;modified&quot;:&quot;2019-11-21 09:49:50&quot;,&quot;has_created_company&quot;:false,&quot;access&quot;:[{&quot;app&quot;:&quot;sales&quot;,&quot;admin&quot;:false,&quot;permission_set_id&quot;:&quot;f07d229d-088a-4144-a40f-1fe64295d180&quot;},{&quot;app&quot;:&quot;global&quot;,&quot;admin&quot;:true,&quot;permission_set_id&quot;:&quot;233b7976-39bd-43a9-b305-ef3a2b0998e5&quot;}],&quot;active_flag&quot;:true,&quot;timezone_name&quot;:&quot;Europe/Berlin&quot;,&quot;timezone_offset&quot;:&quot;+03:00&quot;,&quot;role_id&quot;:1,&quot;icon_url&quot;:null,&quot;is_you&quot;:false,&quot;is_deleted&quot;:false}]}