Read User

Read a user in DocuSign.

Options

Field Definition Type Required
Accounts Choose from available DocuSign accounts. Dropdown TRUE

Input

Field Definition Type Required
User ID

Unique identifier of the user.

String TRUE

Output

Field Definition Type
User Info
Username Username of the user. String
Email Email address of the user. String
User ID

Unique identifier of the user.

String
Default Account ID Default account ID associated with the user. String
User Type Type of the user. String
User Status Status of the user's account; can be of one of these: ActivationRequired, ActivationSent, Active, Closed, or Disabled. String
Permission Profile ID Unique ID of the permission profile associated with the user, can be one of these: 2301416 (for the DocuSign Viewer profile), 2301415 (for the DocuSign Sender profile), or 2301414 (for the Account Administrator profile). String
Permission Profile Name Name of the permission profile associated with the user. String
Personal
Password Password of the user. String
Title

Job title of the user.

String
First Name First name of the user. String
Middle Name Middle name of the user. String
Last Name Last name of the user. String
Suffix Name Suffix name of the user. String
Job Title Job title of the user. String
Company Name of the company with which the user is employed. String
Additional
API Password API password of the user. String
Is NAR Enabled When true, National Association of Realtors (NAR) signature logos are enabled for the user. Boolean
User Added to Account Date Time Date and the time when the user was added to the DocuSign account. String
Connect Configurations Custom Connect configuration of the user. Object
Is Admin When true, the user's feature set is actively set as part of the plan. String
URI URI containing the user ID. String
Created Date Time Date and the time when the user was created in DocuSign. String
Country Code Three-letter code of the user's country. String
Subscribe String
Enable Connect for User When true, the user is enabled for updates from DocuSign Connect. String
Profile Image URI URI of the user's profile image. String
User Profile Last Modified Date Date and the time when the user was modified in DocuSign. String
Signature Image URI URI of the image of the user's signature. String
Initials Image URI URI of the image of the user's initials. String
User Settings
Settings User's settings indicating the actions the user can perform. Object
Forgot Password Info
Question 1 First challenge question presented to the user when they've forgotten their password. String
Answer 1 Answer to the first challenge question. String
Question 2 Second challenge question presented to the user when they've forgotten their password. String
Answer 2 Answer to the second challenge question. String
Question 3 Third challenge question presented to the user when they've forgotten their password. String
Answer 3 Answer to the third challenge question. String
Question 4 Fourth challenge question presented to the user when they've forgotten their password. String
Answer 4 Answer to the fourth challenge question. String
Groups
Group ID Unique ID of the group. String
Group Name Name of the group. String
Group Type Type of group; can be one of these: adminstrators, everyone, customGroup, or sharedSigningGroup. String
Permission Profile ID Unique ID of the permission profile associated with the group, can be one of these: 2301416 (for the DocuSign Viewer profile), 2301415 (for the DocuSign Sender profile), or 2301414 (for the Account Administrator profile). String
User Count Total number of users in the group. String
Work Address
Address One First line of the user's address, maximum 100 characters. String
Address Two Second line of the user's address, maximum 100 characters. String
City City of the user's address, maximum 40 characters. String
State or Province State or province of the user's address, maximum 40 characters. String
Postal Code Postal code of the user's address, maximum 20 characters. String
Phone Phone number associated with the user's address. String
Fax Fax number associated with the user's address. String
Country Country of the user's address, maximum 50 characters. String
Home Address
Address one First line of the user's address, maximum 100 characters. String
Address Two Second line of the user's address, maximum 100 characters. String
City City of the user's address, maximum 40 characters. String
State or Province State or province of the user's address, maximum 40 characters. String
Postal Code Postal code of the user's address, maximum 20 characters. String
Phone Phone number associated with the user's address. String
Fax Fax number associated with the user's address. String
Country Country of the user's address, maximum 50 characters. String
Login Info
Login Status Indicates whether the user is currently logged in or not. String
Password Expiration Date and the time when the user's password expires. String
Last Login Date and the time when the user last logged in DocuSign. String
Send Activation Email When true, an activation email is to be sent. String
Send Activation on Invalid Login When true, additional activation email is sent if user's log on fails before the account is activated. String
Activation Access Code Access code provided to the user to activate the account. String
Custom Settings
Settings User's custom settings. Object

Related topics

DocuSign connector

Workflow elements

DocuSign Developer documentation