Users
Users are people with access to your Pipedrive account. A user may belong to one or many Pipedrive accounts, so deleting a user from one Pipedrive account will not remove the user from the data store if he/she is connected to multiple accounts. Users should not be confused with Persons.
Get all users
/v1/users
Returns data about all users within the company
Response
The list of user objects
Expand all
Copy code- true
- [ ... ]▶
Find users by name
/v1/users/find
Finds users by their name.
Query parameters
term
string
required
Search term to look for
search_by_email
number
When enabled, term will only be matched against email addresses of users. Default: false
Default
1
Values
0
1
Response
The list of user objects
Expand allCopy code- true
- [ ... ]▶
Get current user data
/v1/users/me
Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the locale property means 'Date/number format' in the Pipedrive account settings, not the chosen language.
Response
The data of the logged in user
Expand allCopy code- true
- { ... }▶
Get one user
/v1/users/{id}
Returns data about a specific user within the company
Path parameters
id
integer
required
ID of the user
Response
The data of the User
Expand allCopy code- true
- { ... }▶
List blacklisted email addresses of a user
/v1/users/{id}/blacklistedEmails
Deprecated endpoint
Lists blacklisted email addresses of a specific user. Blacklisted emails are such that will not get synced in to Pipedrive when using the built-in Mailbox.
Path parameters
id
integer
required
ID of the user
Response
success
List followers of a user
/v1/users/{id}/followers
Lists followers of a specific user.
Path parameters
id
integer
required
ID of the user
Response
The list of user IDs
Expand allCopy code- true
- [ ... ]▶
List user permissions
/v1/users/{id}/permissions
List aggregated permissions over all assigned permission sets for a user
Path parameters
id
integer
required
ID of the user
Response
The list of User permissions
Expand allCopy code- true
- { ... }▶
List role assignments
/v1/users/{id}/roleAssignments
List role assignments for a user
Path parameters
id
integer
required
ID of the user
Query parameters
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
Response
List assignments for a role
Expand allCopy code- true
- [ ... ]▶
- { ... }▶
List user role settings
/v1/users/{id}/roleSettings
List settings of user's assigned role
Path parameters
id
integer
required
ID of the user
Response
List role settings
Expand allCopy code- true
- { ... }▶
Add a new user
/v1/users
Adds a new user to the company, returns the ID upon success.
Body parameters
application/x-www-form-urlencoded
name
string
required
Name of the user
string
required
Email of the user
active_flag
boolean
required
Whether the user is active or not. false = Not activated, true = Activated
Default
true
Response
The data of the User
Expand allCopy code- true
- { ... }▶
Add blacklisted email address for a user
/v1/users/{id}/blacklistedEmails
Deprecated endpoint
Add blacklisted email address for a specific user.
Path parameters
id
integer
required
ID of the user
Body parameters
application/x-www-form-urlencoded
address
string
required
Email address to blacklist (can contain \* for wildcards, e.g. \*@example.com, or john\*@ex\*.com)
Response
success
Add role assignment
/v1/users/{id}/roleAssignments
Add role assignment for a user
Path parameters
id
integer
required
ID of the user
Body parameters
application/x-www-form-urlencoded
role_id
integer
required
ID of the role
Response
Add assignment for a role
Expand allCopy code- true
- { ... }▶
Update user details
/v1/users/{id}
Updates the properties of a user. Currently, only active_flag can be updated.
Path parameters
id
integer
required
ID of the user
Body parameters
application/x-www-form-urlencoded
active_flag
boolean
required
Whether the user is active or not. false = Not activated, true = Activated
Default
true
Response
The data of the User
Expand allCopy code- true
- { ... }▶
Delete a role assignment
/v1/users/{id}/roleAssignments
Delete a role assignment for a user
Path parameters
id
integer
required
ID of the user
Query parameters
role_id
integer
required
ID of the role
Response
Delete assignment from a role
Expand allCopy code- true
- { ... }▶