Retrieves the list of users for the specified account. You can filter the users list to get specific 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.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
(Required) The external account number (int) or account ID GUID.
Query Parameters
When true, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is false.
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.
The maximum number of results to return.
Use start_position to specify the number of results to skip.
Valid values: 1 to 100
When true, return only users in domains claimed by your organization. The default value is false.
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.
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.
Filters results based on one or more group IDs.
When true, the response includes the userSettings object data in CSV format.
When true, the response includes the login status of each user.
Return user records excluding the specified group IDs.
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.
Filters results by user account status. A comma-separated list of any of the following:
ActivationRequiredActivationSentActiveClosedDisabled
Filters the user records returned by the user name or a sub-string of user name.
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/users"{ "endPosition": "string", "nextUri": "string", "previousUri": "string", "resultSetSize": "string", "startPosition": "string", "totalSetSize": "string", "users": [ { "activationAccessCode": "string", "company": "string", "connectConfigurations": [ { "configurationtype": "string", "connectId": "string", "enabled": "string", "hasAccess": "string", "senderSearchableItems": [ "string" ] } ], "countryCode": "string", "createdDateTime": "string", "customSettings": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "name": "string", "originalValue": "string", "value": "string" } ], "defaultAccountId": "string", "email": "string", "enableConnectForUser": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "firstName": "string", "forgottenPasswordInfo": { "forgottenPasswordAnswer1": "string", "forgottenPasswordAnswer2": "string", "forgottenPasswordAnswer3": "string", "forgottenPasswordAnswer4": "string", "forgottenPasswordQuestion1": "string", "forgottenPasswordQuestion2": "string", "forgottenPasswordQuestion3": "string", "forgottenPasswordQuestion4": "string" }, "groupList": [ { "accessType": "string", "dsGroupId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "groupId": "string", "groupName": "string", "groupType": "string", "isManagedByScim": true, "lastModifiedOn": "string", "permissionProfileId": "string", "userGroupType": "string", "users": [ { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } ], "usersCount": "string" } ], "hasRemoteNotary": true, "homeAddress": { "address1": "string", "address2": "string", "city": "string", "country": "string", "fax": "string", "phone": "string", "postalCode": "string", "stateOrProvince": "string", "zipPlus4": "string" }, "initialsImageUri": "string", "isAdmin": "string", "isAlternateAdmin": "string", "isManagedByScim": "string", "isMembershipManagedByScim": "string", "isNAREnabled": "string", "jobTitle": "string", "lastLogin": "string", "lastName": "string", "licenseStatus": "string", "licenseType": "string", "loginStatus": "string", "middleName": "string", "password": "string", "passwordExpiration": "string", "permissionProfileId": "string", "permissionProfileName": "string", "profileImageUri": "string", "sendActivationEmail": "string", "sendActivationOnInvalidLogin": "string", "signatureImageUri": "string", "subscribe": "string", "suffixName": "string", "title": "string", "uri": "string", "userAddedToAccountDateTime": "string", "userId": "string", "userName": "string", "userProfileLastModifiedDate": "string", "userSettings": { "accountAgreementsAccessType": "string", "accountManagementGranular": { "canManageAccountSecuritySettings": "string", "canManageAccountSettings": "string", "canManageAdmins": "string", "canManageConnect": "string", "canManageDocumentRetention": "string", "canManageEnvelopeTransfer": "string", "canManageGroupsButNotUsers": "string", "canManageJointAgreements": "string", "canManageReporting": "string", "canManageSharing": "string", "canManageSigningGroups": "string", "canManageStamps": "string", "canManageUsers": "string", "canViewUsers": "string" }, "adminOnly": "string", "allowAccessToAllAccountAgreements": "string", "allowAutoTagging": "string", "allowedDocumentTemplateLibraryAccess": "string", "allowedOrchestrationAccess": "string", "allowEnvelopeTransferTo": "string", "allowEsealRecipients": "string", "allowPowerFormsAdminToAccessAllPowerFormEnvelope": "string", "allowRecipientLanguageSelection": "string", "allowSendOnBehalfOf": "string", "allowSupplementalDocuments": "string", "allowTransactions": "string", "anchorTagVersionedPlacementEnabled": "string", "apiAccountWideAccess": "string", "apiCanExportAC": "string", "bulkSend": "string", "canBulkUploadAgreements": "string", "canChargeAccount": "string", "canCreateTransaction": "string", "canDeleteDocumentsInTransaction": "string", "canDeleteTransaction": "string", "canEditSharedAddressbook": "string", "canLockEnvelopes": "string", "canManageAccount": "string", "canManageAgreementParties": "string", "canManageDistributor": "string", "canManageTemplates": "string", "canSendAPIRequests": "string", "canSendEnvelope": "string", "canSendEnvelopesViaSMS": "string", "canSignEnvelope": "string", "canUseScratchpad": "string", "canUseSmartContracts": "string", "disableDocumentUpload": "string", "disableOtherActions": "string", "enableDSPro": "string", "enableKeyTermsSuggestionsByDocumentType": "string", "enableSequentialSigningAPI": "string", "enableSequentialSigningUI": "string", "enableSignerAttachments": "string", "enableSignOnPaperOverride": "string", "enableTransactionPoint": "string", "enableVaulting": "string", "expressSendOnly": "string", "isManagedByScim": "string", "isMembershipManagedByScim": "string", "locale": "string", "localePolicy": { "addressFormat": "string", "allowRegion": "string", "calendarType": "string", "cultureName": "string", "currencyCode": "string", "currencyNegativeFormat": "string", "currencyPositiveFormat": "string", "customDateFormat": "string", "customSignDateFormat": "string", "customSignTimeFormat": "string", "customTimeFormat": "string", "dateFormat": "string", "effectiveAddressFormat": "string", "effectiveCalendarType": "string", "effectiveCurrencyCode": "string", "effectiveCurrencyNegativeFormat": "string", "effectiveCurrencyPositiveFormat": "string", "effectiveCustomDateFormat": "string", "effectiveCustomTimeFormat": "string", "effectiveDateFormat": "string", "effectiveInitialFormat": "string", "effectiveNameFormat": "string", "effectiveTimeFormat": "string", "effectiveTimeZone": "string", "initialFormat": "string", "nameFormat": "string", "signDateFormat": "string", "signTimeFormat": "string", "timeFormat": "string", "timeZone": "string" }, "manageClickwrapsMode": "string", "modifiedBy": "string", "modifiedDate": "string", "modifiedPage": "string", "newSendUI": "string", "powerFormMode": "string", "recipientViewedNotification": "string", "sealIdentifiers": [ { "sealDisplayName": "string", "sealName": "string" } ], "selfSignedRecipientEmailDocument": "string", "senderEmailNotifications": { "changedSigner": "string", "clickwrapResponsesLimitNotificationEmail": "string", "commentsOnlyPrivateAndMention": "string", "commentsReceiveAll": "string", "deliveryFailed": "string", "envelopeComplete": "string", "offlineSigningFailed": "string", "powerformResponsesLimitNotificationEmail": "string", "purgeDocuments": "string", "recipientViewed": "string", "senderEnvelopeDeclined": "string", "withdrawnConsent": "string" }, "signerEmailNotifications": { "agentNotification": "string", "carbonCopyNotification": "string", "certifiedDeliveryNotification": "string", "commentsOnlyPrivateAndMention": "string", "commentsReceiveAll": "string", "documentMarkupActivation": "string", "envelopeActivation": "string", "envelopeComplete": "string", "envelopeCorrected": "string", "envelopeDeclined": "string", "envelopeVoided": "string", "faxReceived": "string", "offlineSigningFailed": "string", "purgeDocuments": "string", "reassignedSigner": "string", "whenSigningGroupMember": "string" }, "supplementalDocumentIncludeInDownload": "string", "supplementalDocumentsMustAccept": "string", "supplementalDocumentsMustRead": "string", "supplementalDocumentsMustView": "string", "templateActiveCreation": "string", "templateApplyNotify": "string", "templateAutoMatching": "string", "templateMatchingSensitivity": "string", "templatePageLevelMatching": "string", "timezoneDST": "string", "timezoneMask": "string", "timezoneOffset": "string", "timezoneSendingPref": "string", "timezoneSigningPref": "string", "transactionPointSiteNameURL": "string", "transactionPointUserName": "string", "vaultingMode": "string", "webForms": "string" }, "userStatus": "string", "userType": "string", "workAddress": { "address1": "string", "address2": "string", "city": "string", "country": "string", "fax": "string", "phone": "string", "postalCode": "string", "stateOrProvince": "string", "zipPlus4": "string" } } ]}Updates the user profile information for the specified user PUT
Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.
Adds new users to the specified account POST
Adds new users to an account. The body of this request is an array of `newUsers` objects. For each new user, you must provide at least the `userName` and `email` properties. The maximum number of users you can create in one request is 500 users. The `userSettings` property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the `locale` is set to `fr`. ``` POST /restapi/v2.1/accounts/{accountId}/users Content-Type: application/json ``` ``` { "newUsers": [ { "userName": "Claire Horace", "email": "claire@example.com" }, { "userName": "Tal Mason", "email": "talmason@example.com", "company": "TeleSel", "userSettings": { "locale": "fr", "canSendEnvelope": true } } ] } ``` A successful response is a `newUsers` array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an `errorDetails` property that describes what went wrong. ```json { "newUsers": [ { "userId": "18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade", "uri": "/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade", "email": "claire@example.com", "userName": "Claire Horace", "createdDateTime": "0001-01-01T08:00:00.0000000Z", "errorDetails": { "errorCode": "USER_ALREADY_EXISTS_IN_ACCOUNT", "message": "Username and email combination already exists for this account." } }, { "userId": "be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33", "uri": "/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33", "email": "talmason@example.com", "userName": "Tal Mason", "userStatus": "ActivationSent", "createdDateTime": "2020-05-26T23:25:30.7330000Z" } ] } ```