Skip to content

DocuSign: Retrieves the list of users for the specified account You can filter the users list to get specific users

DocuSign esignature.esignatureUsersGetUsers: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_users_getusers

Provider route: GET /restapi/v2.1/accounts/{accountId}/users. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureUsersGetUsers"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureUsersGetUsers(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_users_get_users(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.additional_infostringOptional
query.alternate_admins_onlystringOptional
query.countstringOptional
query.domain_users_onlystringOptional
query.emailstringOptional
query.email_substringstringOptional
query.group_idstringOptional
query.include_licensestringOptional
query.include_usersettings_for_csvstringOptional
query.login_statusstringOptional
query.not_group_idstringOptional
query.start_positionstringOptional
query.statusstringOptional
query.user_name_substringstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieves the list of users for the specified account You can filter the users list to get specific users — response body

Referenced models: Retrieves the list of users for the specified account You can filter the users list to get specific users — response body

13 more schemas are linked from the tables above, on the schema pages.

Retrieves the list of users for the specified account You can filter the users list to get specific users — response body
FieldTypePresenceDescription and constraints
$objectRootContains a list of account users.
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
usersarrayOptionalUser management information.
users[]ModelEach itemExpand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body

Referenced models: Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body

Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
FieldTypePresenceDescription and constraints
$objectRootUser information.
activationAccessCodestringOptionalAccess code provided to the user to activate the account.
companystringOptionalThe name of the user's company.
connectConfigurationsarrayOptionalObject representing the user's custom Connect configuration.
connectConfigurations[]ModelEach itemExpand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — connect Configurations item
countryCodestringOptionalThe two-letter code for the user's country.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
customSettingsarrayOptionalThe name/value pair information for the user custom setting.
customSettings[]ModelEach itemExpand Updates an existing brand — response body — colors item
defaultAccountIdstringOptionalThe default account ID associated with the user.
emailstringOptionalThe user's email address.

This property cannot be updated via `PUT` requests.
enableConnectForUserstringOptionalBoolean value that specifies whether the user is enabled for updates from Docusign Connect.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
firstNamestringOptionalThe user's first name.
Maximum Length: 50 characters.
forgottenPasswordInfoModelOptionalExpand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — forgotten Password Info
A complex element containing up to four Question/Answer pairs for forgotten password information.
groupListarrayOptionalA list of the group information for groups to add the user to.
Use [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups.

When setting a user's group, only the `groupId` is required.
groupList[]ModelEach itemExpand Deletes an existing user group — response body — groups item
hasRemoteNotarybooleanOptional
homeAddressModelOptionalExpand Get credit card information — response body — address
Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type.
Maximum Length: 100 characters.
initialsImageUristringOptionalThe URI for retrieving the image of the user's initials.
isAdminstringOptionalWhen **true,** the user is an administrator.
isAlternateAdminstringOptionalWhen **true,** the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.
isManagedByScimstringOptional
isMembershipManagedByScimstringOptional
isNAREnabledstringOptionalWhen **true,** National Association of Realtors (NAR) signature logos are enabled for the user.
jobTitlestringOptionalThe user's job title.
lastLoginstringOptionalThis property has been deprecated.
lastNamestringOptionalThe user's last name.
Maximum Length: 50 characters.
licenseStatusstringOptional
licenseTypestringOptional
loginStatusstringOptionalBoolean value that indicates whether the user is currently logged in or not.
middleNamestringOptionalThe user's middle name.
Limit: 50 characters.
passwordstringOptionalThe user's password.

This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).

This property is not returned by `GET` requests and cannot be updated via `PUT` requests.
passwordExpirationstringOptionalIf password expiration is enabled, the date-time when the user's password expires.
permissionProfileIdstringOptionalThe ID of the permission profile.

Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)
to get a list of permission profiles and their IDs.

You can also download a CSV file of all permission profiles
and their IDs from the **Settings > Permission Profiles** page
of your eSignature account page.
permissionProfileNamestringOptionalThe name of the account permission profile.

Example: `Account Administrator`
profileImageUristringOptionalThe URL for retrieving the user's profile image.
sendActivationEmailstringOptionalThis field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).
sendActivationOnInvalidLoginstringOptionalWhen **true,** specifies that an additional activation email be sent if user's log on fails before the account is activated.
signatureImageUristringOptionalAn endpoint URI that you can use to retrieve the user's signature image.
subscribestringOptional
suffixNamestringOptionalThe suffix for the user's name, such as Jr, IV, PhD, etc.

Limit: 50 characters.
titlestringOptionalThe title of the user.
uristringOptionalA URI containing the user ID.
userAddedToAccountDateTimestringOptionalThe date and time that the user was added to the account.
userIdstringOptionalThe ID of the user to access.

**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
userNamestringOptionalThe name of the user.
userProfileLastModifiedDatestringOptionalThe date and time that the user's profile was last modified.
userSettingsModelOptionalExpand Gets the user account settings for a specified user — response body
The collection of settings representing the actions a user can perform. See [userSettingsInformation](/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings.
userStatusstringOptionalStatus of the user's account. One of:

- `ActivationRequired`
- `ActivationSent`
- `Active`
- `Closed`
- `Disabled`
userTypestringOptionalThe type of user, for example `CompanyUser`.
workAddressModelOptionalExpand Get credit card information — response body — address

Referenced models: Get credit card information — response body — address, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — connect Configurations item, Locks a template — response body — error Details, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — forgotten Password Info, Deletes an existing user group — response body — groups item, Updates an existing brand — response body — colors item, Gets the user account settings for a specified user — response body

Get credit card information — response body — address
FieldTypePresenceDescription and constraints
$objectRootContains address information.
address1stringOptionalThe first line of the user's address.
Maximum length: 100 characters.
address2stringOptionalThe second line of the user's address.
Maximum length: 100 characters.
citystringOptionalThe user's city. Maximum length: 40 characters.
countrystringOptionalThe user's country. Maximum length: 50 characters.
faxstringOptionalA fax number associated with the address, if one is available.
phonestringOptionalA phone number associated with the address.
postalCodestringOptionalThe user's postal code. Maximum length: 20 characters.
stateOrProvincestringOptionalThe user's state or province. Maximum length: 40 characters.
zipPlus4stringOptional

SDK function policy ID: docusign.esignature_users_getusers. Catalog operation: esignature:Users_GetUsers. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.