docusign.users.get-users

Retrieves the list of users for the specified account. The response returns the list of users for the account, with information about the result set. If the additional_info query is added to the endpoint and set to true, full user information is returned for each user.

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

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	(Required) The external account number (int) or account ID GUID.
additional_info	string	No	—	When true, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is false.
alternate_admins_only	string	No	—	When true, returns only alternate administrators. These users are not administrators but will be set as such if all administrator memberships are closed. The default value is false.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip. Valid values: 1 to 100
domain_users_only	string	No	—	When true, return only users in domains claimed by your organization. The default value is false.
email	string	No	—	Filters results based on the email address associated with the user that you want to return. Note: You can use either this parameter or the email_substring parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address.
email_substring	string	No	—	Filters results based on a fragment of an email address. For example, you could enter gmail.com to return all users who have Gmail addresses. Note: You do not use a wildcard character with this parameter. You can use either this parameter or the email parameter, but not both.
group_id	string	No	—	Filters results based on one or more group IDs.
include_license	string	No	—	—
include_usersettings_for_csv	string	No	—	When true, the response includes the userSettings object data in CSV format.
login_status	string	No	—	When true, the response includes the login status of each user.
not_group_id	string	No	—	Return user records excluding the specified group IDs.
start_position	string	No	—	The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.
status	string	No	—	Filters results by user account status. A comma-separated list of any of the following: * ActivationRequired * ActivationSent * Active * Closed * Disabled
user_name_substring	string	No	—	Filters the user records returned by the user name or a sub-string of user name.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	(Required) The external account number (int) or account ID GUID.
additional_info	string	No	—	When true, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is false.
alternate_admins_only	string	No	—	When true, returns only alternate administrators. These users are not administrators but will be set as such if all administrator memberships are closed. The default value is false.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip. Valid values: 1 to 100
domain_users_only	string	No	—	When true, return only users in domains claimed by your organization. The default value is false.
email	string	No	—	Filters results based on the email address associated with the user that you want to return. Note: You can use either this parameter or the email_substring parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address.
email_substring	string	No	—	Filters results based on a fragment of an email address. For example, you could enter gmail.com to return all users who have Gmail addresses. Note: You do not use a wildcard character with this parameter. You can use either this parameter or the email parameter, but not both.
group_id	string	No	—	Filters results based on one or more group IDs.
include_license	string	No	—	—
include_usersettings_for_csv	string	No	—	When true, the response includes the userSettings object data in CSV format.
login_status	string	No	—	When true, the response includes the login status of each user.
not_group_id	string	No	—	Return user records excluding the specified group IDs.
start_position	string	No	—	The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.
status	string	No	—	Filters results by user account status. A comma-separated list of any of the following: * ActivationRequired * ActivationSent * Active * Closed * Disabled
user_name_substring	string	No	—	Filters the user records returned by the user name or a sub-string of user name.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call GET /v2.1/accounts/{accountId}/users
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform GET /v2.1/accounts/{accountId}/users
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.users.get-users",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}