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.
Returns data about all users within the company.
/v1/users
OK
Finds users by their name.
/v1/users/find
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
OK
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.
/v1/users/me
OK
Returns data about a specific user within the company.
/v1/users/{id}
id
integer
required
The ID of the user
OK
Lists the followers of a specific user.
/v1/users/{id}/followers
id
integer
required
The ID of the user
OK
Lists aggregated permissions over all assigned permission sets for a user.
/v1/users/{id}/permissions
id
integer
required
The ID of the user
OK
Lists role assignments for a user.
/v1/users/{id}/roleAssignments
id
integer
required
The ID of the user
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
OK
Lists the settings of user's assigned role.
/v1/users/{id}/roleSettings
id
integer
required
The ID of the user
OK
Adds a new user to the company, returns the ID upon success.
/v1/users
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
OK
Updates the properties of a user. Currently, only active_flag
can be updated.
/v1/users/{id}
id
integer
required
The ID of the user
application/json
active_flag
boolean
required
Whether the user is active or not. false
= Not activated, true
= Activated
OK