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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.additional_info | string | Optional | |
query.alternate_admins_only | string | Optional | |
query.count | string | Optional | |
query.domain_users_only | string | Optional | |
query.email | string | Optional | |
query.email_substring | string | Optional | |
query.group_id | string | Optional | |
query.include_license | string | Optional | |
query.include_usersettings_for_csv | string | Optional | |
query.login_status | string | Optional | |
query.not_group_id | string | Optional | |
query.start_position | string | Optional | |
query.status | string | Optional | |
query.user_name_substring | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand 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
Schemas
Section titled “Schemas”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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains a list of account users. |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The 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. |
previousUri | string | Optional | The 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. |
resultSetSize | string | Optional | The 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`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
users | array | Optional | User management information. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User information. |
activationAccessCode | string | Optional | Access code provided to the user to activate the account. |
company | string | Optional | The name of the user's company. |
connectConfigurations | array | Optional | Object representing the user's custom Connect configuration. |
connectConfigurations[] | Model | Each item | Expand 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 |
countryCode | string | Optional | The two-letter code for the user's country. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
customSettings | array | Optional | The name/value pair information for the user custom setting. |
customSettings[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
defaultAccountId | string | Optional | The default account ID associated with the user. |
email | string | Optional | The user's email address. This property cannot be updated via `PUT` requests. |
enableConnectForUser | string | Optional | Boolean value that specifies whether the user is enabled for updates from Docusign Connect. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
firstName | string | Optional | The user's first name. Maximum Length: 50 characters. |
forgottenPasswordInfo | Model | Optional | Expand 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. |
groupList | array | Optional | A 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[] | Model | Each item | Expand Deletes an existing user group — response body — groups item |
hasRemoteNotary | boolean | Optional | |
homeAddress | Model | Optional | Expand 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. |
initialsImageUri | string | Optional | The URI for retrieving the image of the user's initials. |
isAdmin | string | Optional | When **true,** the user is an administrator. |
isAlternateAdmin | string | Optional | When **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. |
isManagedByScim | string | Optional | |
isMembershipManagedByScim | string | Optional | |
isNAREnabled | string | Optional | When **true,** National Association of Realtors (NAR) signature logos are enabled for the user. |
jobTitle | string | Optional | The user's job title. |
lastLogin | string | Optional | This property has been deprecated. |
lastName | string | Optional | The user's last name. Maximum Length: 50 characters. |
licenseStatus | string | Optional | |
licenseType | string | Optional | |
loginStatus | string | Optional | Boolean value that indicates whether the user is currently logged in or not. |
middleName | string | Optional | The user's middle name. Limit: 50 characters. |
password | string | Optional | The 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. |
passwordExpiration | string | Optional | If password expiration is enabled, the date-time when the user's password expires. |
permissionProfileId | string | Optional | The 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. |
permissionProfileName | string | Optional | The name of the account permission profile. Example: `Account Administrator` |
profileImageUri | string | Optional | The URL for retrieving the user's profile image. |
sendActivationEmail | string | Optional | This 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/). |
sendActivationOnInvalidLogin | string | Optional | When **true,** specifies that an additional activation email be sent if user's log on fails before the account is activated. |
signatureImageUri | string | Optional | An endpoint URI that you can use to retrieve the user's signature image. |
subscribe | string | Optional | |
suffixName | string | Optional | The suffix for the user's name, such as Jr, IV, PhD, etc. Limit: 50 characters. |
title | string | Optional | The title of the user. |
uri | string | Optional | A URI containing the user ID. |
userAddedToAccountDateTime | string | Optional | The date and time that the user was added to the account. |
userId | string | Optional | The 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. |
userName | string | Optional | The name of the user. |
userProfileLastModifiedDate | string | Optional | The date and time that the user's profile was last modified. |
userSettings | Model | Optional | Expand 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. |
userStatus | string | Optional | Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` |
userType | string | Optional | The type of user, for example `CompanyUser`. |
workAddress | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains address information. |
address1 | string | Optional | The first line of the user's address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the user's address. Maximum length: 100 characters. |
city | string | Optional | The user's city. Maximum length: 40 characters. |
country | string | Optional | The user's country. Maximum length: 50 characters. |
fax | string | Optional | A fax number associated with the address, if one is available. |
phone | string | Optional | A phone number associated with the address. |
postalCode | string | Optional | The user's postal code. Maximum length: 20 characters. |
stateOrProvince | string | Optional | The user's state or province. Maximum length: 40 characters. |
zipPlus4 | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.