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
Returns data about all users within the company.
Request
/v1/users
Response
OK
Expand all
Copy code- true
- [ ... ]▶
Find users by name
Finds users by their name.
Request
/v1/users/find
Query parameters
term
string
required
The search term to look for
search_by_email
number
When enabled, the term will only be matched against email addresses of users. Default: false.
Default
0
Values
0
1
Response
OK
Expand allCopy code- true
- [ ... ]▶
Get current user data
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.
Request
/v1/users/me
Response
OK
Expand allCopy code- true
- { ... }▶
Get one user
Returns data about a specific user within the company.
Request
/v1/users/{id}
Path parameters
id
integer
required
The ID of the user
Response
OK
Expand allCopy code- true
- { ... }▶
List followers of a user
Lists the followers of a specific user.
Request
/v1/users/{id}/followers
Path parameters
id
integer
required
The ID of the user
Response
OK
Expand allCopy code- true
- [ ... ]▶
List user permissions
Lists aggregated permissions over all assigned permission sets for a user.
Request
/v1/users/{id}/permissions
Path parameters
id
integer
required
The ID of the user
Response
OK
Expand allCopy code- true
- { ... }▶
List role assignments
Lists role assignments for a user.
Request
/v1/users/{id}/roleAssignments
Path parameters
id
integer
required
The ID of the user
Query parameters
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
Response
OK
Expand allCopy code- true
- [ ... ]▶
- { ... }▶
List user role settings
Lists the settings of user's assigned role.
Request
/v1/users/{id}/roleSettings
Path parameters
id
integer
required
The ID of the user
Response
OK
Expand allCopy code- true
- { ... }▶
Add a new user
Adds a new user to the company, returns the ID upon success.
Request
/v1/users
Body parameters
application/json
string
required
The email of the user
access
array
The access given to the user. Each item in the array represents access to a specific app. Optionally may include either admin flag or permission set ID to specify which access to give within the app. If both are omitted, the default access for the corresponding app will be used. It requires structure as follows: [{ app: 'sales', permission_set_id: '62cc4d7f-4038-4352-abf3-a8c1c822b631' }, { app: 'global', admin: true }, { app: 'account_settings' }]
Default
[object Object]
active_flag
boolean
Whether the user is active or not. false = Not activated, true = Activated
Default
true
Response
OK
Expand allCopy code- true
- { ... }▶
Update user details
Updates the properties of a user. Currently, only active_flag can be updated.
Request
/v1/users/{id}
Path parameters
id
integer
required
The ID of the user
Body parameters
application/json
active_flag
boolean
required
Whether the user is active or not. false = Not activated, true = Activated
Response
OK
Expand allCopy code- true
- { ... }▶