Module users_api

Source

Enums§

AddUserError
struct for typed errors of method add_user
FindUsersByNameError
struct for typed errors of method find_users_by_name
GetCurrentUserError
struct for typed errors of method get_current_user
GetUserError
struct for typed errors of method get_user
GetUserFollowersError
struct for typed errors of method get_user_followers
GetUserPermissionsError
struct for typed errors of method get_user_permissions
GetUserRoleAssignmentsError
struct for typed errors of method get_user_role_assignments
GetUserRoleSettingsError
struct for typed errors of method get_user_role_settings
GetUsersError
struct for typed errors of method get_users
UpdateUserError
struct for typed errors of method update_user

Functions§

add_user
Adds a new user to the company, returns the ID upon success.
find_users_by_name
Finds users by their name.
get_current_user
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.
get_user
Returns data about a specific user within the company.
get_user_followers
Lists the followers of a specific user.
get_user_permissions
Lists aggregated permissions over all assigned permission sets for a user.
get_user_role_assignments
Lists role assignments for a user.
get_user_role_settings
Lists the settings of user’s assigned role.
get_users
Returns data about all users within the company.
update_user
Updates the properties of a user. Currently, only active_flag can be updated.