Create a connection to DocuSign by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the DocuSign icon is not available, click the Add More icon to download and install the DocuSign connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Important connection properties

UseSandbox
UseSandbox indicates whether the current user account is sandbox or not. This is false by default. Set to true if you are using a sandbox account. All the OAuth flows documented below assume that you have set UseSandbox beforehand.

AccountId
AccountId is an optional connection property. It sets automatically after the authentication succeeds. As an alternative, you can manually set it in the connection string if you have access to multiple Account Ids. In order to retrieve account ids, query the UserInfo view.

Authenticating to DocuSign

DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you must create a custom app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See Creating a Custom OAuth App for more information about creating custom applications.

Web Applications

When connecting via a Web application, you need to register a custom OAuth app with DocuSign. See Creating a Custom OAuth App. You can then use the Sync App to get and manage the OAuth token values. Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
• OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings.

   The stored procedure returns the URL to the OAuth endpoint.

2. Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL.

Refresh the OAuth Access Token

You can either set InitiateOAuth to REFRESH to automatically refresh the OAuth access token when it expires or call the RefreshOAuthAccessToken stored procedure to refresh the token manually.

Automatic Refresh

To refresh the token with InitiateOAuth, set the following on the first data connection:

• OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
• InitiateOAuth: Set this to REFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthSettingsLocation: Set this to the path where the Sync App saves the OAuth values. These values persist across connections.
• OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
• OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
• OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.

On subsequent data connections, set the following:

• InitiateOAuth
• OAuthSettingsLocation

Manual Refresh

You can use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken. Call the stored procedure after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed. You need to set the following connection properties:

• OAuthClientId: Set this to the Client Id in your app settings.
• OAuthClientSecret: Set this to the Client Secret in your app settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuthRefreshToken returned by GetOAuthAccessToken.

Fine Tuning Data Access

• AccountId: An optional account id that can be specified in case you have access to multiple.
• DirectoryRetrievalDepth: The depth of folders to scan when listing available folders (ie: how many subfolders deep).
• IncludeCustomFields: Set to true if you want to retrieve custom fields values for an envelope or template.
• Url: Base API url associated with your account. Defaulted just like the AccountId.
• UseSandbox: Set to true if you are using a sandbox.

This section details a selection of advanced features of the DocuSign Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to DocuSign and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API objects and provides more information on executing SQL to DocuSign APIs.

Key Features

• The Sync App models DocuSign entities like documents, folders, and groups as relational views, allowing you to write SQL to query DocuSign data.
• Stored procedures allow you to execute operations to DocuSign, including retrieving the access token and keeping it refreshed in OAuth 2.0.
• Live connectivity to these objects means any changes to your DocuSign account are immediately reflected when using the Sync App.

Views

Views describes the available views. Views are statically defined to model Accounts, Documents, Folders, and more.

Stored Procedures

Stored Procedures are function-like interfaces to DocuSign. Stored procedures allow you to execute operations to DocuSign, including downloading documents and moving envelopes.

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

DocuSign Connector for CData Sync Views

Name	Description
AccountBrands	The AcccountBrands resource provides methods that allow you to manage the account brand associated with an account.
AccountCustomFields	The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.
Accounts	The Accounts resource provides methods that allow you to manage your accounts.
BulkEnvelopes	Retrieves status information about all the bulk recipient batches.
BulkRecipients	The BulkRecipients resource provide methods that allow you manage the bulk recipient file for an envelope or template.
CloudStorageProviders	The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.
CustomTabs	The CustomTabs resource provides methods that allow you to manage custom tabs based on the existing DocuSign tabs.
Documents	The Documents resource provides methods that manage documents in an envelope or template.
DocumentTabs	The DocumentTabs resource provides methods that allow you to manage various tabs in envelopes or templates.
DocumentVisibility	The Document Visibility resource provides methods that manage document views and insights in an envelope or template.
EnvelopeAttachments	The EnvelopeAttachments resource provides methods that allow you to manage attachments.
EnvelopeConsumerDisclosures	The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope.
Envelopes	The Envelope resource provides methods that allow you to manage envelopes.
EnvelopeTemplates	The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents.
Folders	Retrieves a list of the folders for the account.
GroupBrands	The GroupBrands resource provides methods that allow you to manage brands in a group.
Groups	The Groups resource provides methods that allow you to manage groups for the account.
GroupUsers	The GroupUsers resource provides methods that allow you to manage the users in a group.
Locks	The Locks resource provides methods that allow you to manage locks on an envelope or template.
PowerForms	The PowerForms resource provides methods that allow you to manage power forms.
Recipients	The Recipients resource allows you manage the recipients of an envelope or template.
RecipientTabs	The RecipientTabs resource provides methods that let you add, update, and delete tabs from an envelope or template.
SigningGroups	Returns data from a sample table.
SigningGroupUsers	The SigningGroupUsers resource provides methods that allow you to manage users in Signing Groups.
Templates	The Template resource provides methods that allow you to manage templates.
UserInfo	The UserInfo resource provides methods that allow you to manage your current user info.
Users	The Users resource provides methods that allow you to manage users for an account.
UserSignatures	The UserSignatures resource provides methods that allow you manage the intials and signature images for a user.
Workspaces	The Workspaces resource provides methods that allow you to manage workspaces.

The AcccountBrands resource provides methods that allow you to manage the account brand associated with an account.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM AccountBrands WHERE BrandId = '4701f9c2-1038-45cf-bf35-66ae143a5656'

Columns

Name	Type	References	Description
BrandId [KEY]	String		Id of the brand.
BrandName	String		Name of the brand.
BrandCompany	String		The name of the company associated with this brand.
IsOverridingCompanyName	Boolean		When is set to true, brand name is the name of the company.
IsSendingDefault	Boolean		When is set to true, it is sending default.
IsSigningDefault	Boolean		When is set to true, it is signing default.

The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
FieldId [KEY]	Integer		An ID used to specify a custom field.
Name	String		The name of the custom field.
CustomFieldType	String		Type of the custom field.
ListOfValues	String		Comma separated value of the .
Show	Boolean		A boolean indicating if the value should be displayed. If this value is set to true, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to false, then it does not appear in the certificate of completion.
Required	Boolean		When set to true, the signer is required to fill out this tab
ConfigurationType	String		If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

The Accounts resource provides methods that allow you to manage your accounts.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
AccountId [KEY]	Integer		Id of the account.
AccountIdGuid	String		The GUID associated with the account ID.
AccountName	String		The name of the current account.
CreatedDate	Datetime		The date when account was created.
CurrencyCode	String		Specifies the ISO currency code for the account.
CurrentPlanId	String		Identifies the plan that was used create this account.
PlanName	String		The name of the Billing Plan.
PlanClassification	String		Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.
PlanStartDate	Datetime		The date that the Account started using the current plan.
PlanEndDate	Datetime		The date that the current plan will end.
PaymentMethod	String		Method of the payment.
EnvelopeUnitPrice	String		Price of an envelope.
EnvelopeSendingBlocked	Boolean		When set to true, user can not send envelopes.
BillingProfile	String		The name of the Billing Profile.
BillingPeriodStartDate	Datetime		The UTC DateTime that account billing started.
BillingPeriodEndDate	Datetime		The UTC DateTime that account billing finish.
BillingPeriodDaysRemaining	Integer		Number of remaining billing days.
BillingPeriodEnvelopesSent	Integer		Number of sent envelopes.
BillingPeriodEnvelopesAllowed	String		Specifies the allowed number of sent envelopes.
CanCancelRenewal	Boolean		When set to true, specifies that you can cancel renewal.
CanUpgrade	Boolean		When set to true, specifies that you can upgrade the account through the API.
IsDowngrade	Boolean		When set to true, specifies that your account is downgraded.
AllowTransactionRooms	Boolean		When set to true, the transaction rooms feature exposed through the Workspaces API is enabled.

Retrieves status information about all the bulk recipient batches.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• BatchId supports the '='.

For example, the following query is processed server side:

SELECT * FROM BulkEnvelopes WHERE BatchId = 'eaf12958-f1c8-4636-9a29-42c63fa80ab5'

Columns

Name	Type	References	Description
BatchId [KEY]	String		Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
BatchSize	Integer		The number of items returned in this response.
BulkEnvelopesBatchUri	String		Uri of the bulk envelopes.
SubmittedDate	Datetime		The date that it is submitted.
Sent	Integer		The number of entries with a status of sent.
Failed	Integer		The number of entries with a status of failed.
Queued	Integer		The number of entries with a status of queued.

The BulkRecipients resource provide methods that allow you manage the bulk recipient file for an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

For example:

SELECT * FROM BulkRecipients WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b' AND RecipientId = 77419544
SELECT * FROM BulkRecipients WHERE Type = 'templates' AND Id = 'd194aa0a-723e-4db9-a8be-801dffbb63ff' AND RecipientId = 75619544

Columns

Name	Type	References	Description
Type	String		Specifies where the bulk is applied. Possible options are envelopes or templates
Id	String		Id of the Envelope or Template.
RecipientId	Integer	Recipients.RecipientId	Unique Id for the recipient.
Email	String		Specifies the recipient's email address.
Name	String		Specifies the recipient's name.
RowNumber [KEY]	Integer		Specifies the row number of the recipient in the list.
Note	String		A note sent to the recipient in the signing email. This note is unique to this recipient.
AccessCode	String		If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
PhoneNumber	String		This is only used if the Identification field value is Phone or SMS.
Identification	String		Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer.The acceptable values are: KBA: Enables the normal ID check authentication set up for your account. Phone: Enables phone authentication. SMS: Enables SMS authentication.

The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.

View Specific Information

In order to make a successful request on this view, you have to specify UserId.

For example:

SELECT * FROM CloudStorageProviders WHERE UserId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• ServiceId supports the '='.

For example, the following query is processed server side:

SELECT * FROM CloudStorageProviders WHERE userId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a' AND ServiceId = '440189'

Columns

Name	Type	References	Description
UserId	String		Id of the user account
ServiceId	String		The DocuSign generated ID for the cloud storage provider
Service [KEY]	String		The service name for the cloud storage provider.
AuthenticationUrl	String		The authentication URL used for the cloud storage provider.
RedirectUrl	String		The URL the user is redirected to after the cloud storage provider authenticates the user.

The CustomTabs resource provides methods that allow you to manage custom tabs based on the existing DocuSign tabs.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• CustomTabId supports the '='.

For example, the following query is processed server side:

SELECT * FROM CustomTabs WHERE CustomTabId = '926770b6-1cb6-487c-918c-dacf8c9caa2a'

Columns

Name	Type	References	Description
CustomTabId [KEY]	String		The DocuSign generated custom tab ID for the custom tab to be applied.
Name	String		Name of the tab.
Type	String		The type of this tab.
TabLabel	String		The label string associated with the tab.
Font	String		The font to be used for the tab value.
Bold	Boolean		When set to true, the information in the tab is bold.
Italic	Boolean		When set to true, the information in the tab is italic.
Underline	Boolean		When set to true, the information in the tab is underlined.
FontColor	String		The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White.
FontSize	String		The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72.
Width	Integer		Width of the tab in pixels.
Height	Integer		Height of the tab in pixels.
Editable	Boolean		When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified.
DisableAutoSize	Boolean		When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
CreatedByUserId	String		The userId of the DocuSign user who created this object.
CreatedByDisplayName	String		The user name of the DocuSign user who created this object.
Locked	Boolean		When set to true, the signer cannot change the data of the custom tab.
LastModified	Datetime		The UTC DateTime this object was last modified. This is in ISO8601 format.
LastModifiedByUserId	String		The userId of the DocuSign user who last modified this object.
LastModifiedByDisplayName	String		The User Name of the DocuSign user who last modified this object.

The Documents resource provides methods that manage documents in an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

For example:

SELECT * FROM Documents WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b'
SELECT * FROM Documents WHERE Type = 'templates' AND Id = 'd5c67830-b37a-4171-9e87-3de377b35a90'

Columns

Name	Type	References	Description
Id	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
DocumentId [KEY]	String		Specifies the document Id number that the tab is placed on. This must refer to an existing Document's ID attribute.
DocumentName	String		Specifies the document name.
DocumentType	String		Specifies the document type.
Uri	String		Uri of the document.
Display	String		This string sets the display and behavior properties of the document during signing. The possible values are: modal - The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. download - The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window. inline - The document is shown in the normal signing window.
Order	Integer		An optional value that sets the direction order used to sort the item list. Valid values are: asc = ascending sort order. desc = descending sort order.
Pages	Integer		Number of pages in a document.
DocumentGroup	String		Group of the document.
AttachmentTabId	String		Id of the attachment tab.
AuthoritativeCopy	Boolean		Specifies whether all documents in this envelope are authoritative copies. A document can set its own authoritativeCopy property to override this value. For example you can set the authoritativeCopy on an envelope level to true but can turn it off for a specific document.
ContainsPdfFormFields	String		Indicates pdf form fields.
IncludeInDownload	Boolean		When set to true, the document is included in the combined document download. The default value is true.
SignerMustAcknowledge	String		Sets how the signer interacts with the supplemental document. The possible values are: no_interaction - No recipient action is required. view- The recipient is required to view the document. accept - The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. view_accept - The recipient is required to view and accept the document.

The DocumentTabs resource provides methods that allow you to manage various tabs in envelopes or templates.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• DocumentId - Id of the document.

For example:

SELECT * FROM DocumentTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND DocumentId = '1'
SELECT * FROM DocumentTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND DocumentId = '1'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• PageNumber supports the '='.

For example, the following queries are processed server side:

SELECT * FROM DocumentTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND DocumentId = '1' AND PageNumber = 1
SELECT * FROM DocumentTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND DocumentId = '1' AND PageNumber = 3

Columns

Name	Type	References	Description
Id	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
DocumentId	String	Documents.DocumentId	Specifies the document ID that the tab is placed on.
RecipientId	String		Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
PageNumber	Integer		Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
TabId [KEY]	String		The unique identifier for the tab.
CustomTabId	String		The DocuSign generated custom tab ID for the custom tab to be applied.
TabName	String		Name of the tab.
Value	String		Specifies the value of the tab.
Status	String		Status of the tab.
TabLabel	String		The label string associated with the tab.
Font	String		The font to be used for the tab value.
Bold	Boolean		When set to true, the information in the tab is bold.
Italic	Boolean		When set to true, the information in the tab is italic.
Underline	Boolean		When set to true, the information in the tab is underlined.
FontColor	String		The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White.
FontSize	String		The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72.
XPosition	Integer		This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
YPosition	Integer		This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
AnchorString	String		Specifies the anchor string.
AnchorXOffset	String		Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
AnchorYOffset	String		Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
AnchorUnits	String		Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
AnchorIgnoreIfNotPresent	Boolean		When set to true, this tab is ignored if anchorString is not found in the document.
TemplateLocked	Boolean		When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
TemplateRequired	Boolean		When set to true, the sender may not remove the recipient. Used only when working with template recipients.
ConditionalParentLabel	String		For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
ConditionalParentValue	String		For conditional fields, this is the value of the parent tab that controls the tab's visibility.

The Document Visibility resource provides methods that manage document views and insights in an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

For example:

SELECT * FROM DocumentVisibility WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b' AND RecipientId = 77419544
SELECT * FROM DocumentVisibility WHERE Type = 'templates' AND Id = 'd194aa0a-723e-4db9-a8be-801dffbb63ff' AND RecipientId = 75619544

Columns

Name	Type	References	Description
Id [KEY]	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
RecipientId	Integer		Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
DocumentId	String	Documents.DocumentId	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
Visible	Boolean		When set to true, the document is visible.
Rights	String		Rights of the recipient for this document.

The EnvelopeAttachments resource provides methods that allow you to manage attachments.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId.

For example:

SELECT * FROM EnvelopeAttachments WHERE EnvelopeId = '56e3ca38-8008-441e-a29e-eb23dd3269e1'

Columns

Name	Type	References	Description
EnvelopeId	String	Envelopes.EnvelopeId	The envelope ID.
AttachmentId [KEY]	String		Id of the attachment.
AttachmentType	String		Type of the attachment.
Name	String		Name of the attachment.
Label	String		Label of the attachment.
AccessControl	String		AccessControl of the attachment.

The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId and RecipientId.

For example:

SELECT * FROM [EnvelopeConsumerDisclosures] WHERE EnvelopeId = '7cc4251f-31ca-4a79-8221-53451222292d' AND RecipientId = 68364179

Columns

Name	Type	References	Description
EnvelopeId	String		The envelope ID.
RecipientId	String		Unique Id for the recipient.
AccountEsignId [KEY]	String		A GUID identifying the account associated with the consumer disclosure.
CompanyName	String		The name of the company associated with the consumer disclosure.
CompanyPhone	String		The phone number of the company associated with the consumer disclosure.
ChangeEmail	String		Email of the account.
ChangeEmailOther	String		Other email information.
CopyCostPerPage	String		Copy cost for a page.
CopyFeeCollectionMethod	String		Specifies the fee collection method for cases in which the customer requires paper copies of the document.
EnableEsign	String		When is set to true, Esign is enabled.
EsignAgreement	String		The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.
EsignText	String		Text of the Esign.
MustAgreeToEsign	String		When is set ti true, customer must agree.
PdfId	String		The pdfId property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored.
AllowCDWithdraw	String		Indicates whether the customer can withdraw their acceptance of the consumer disclosure.
WithdrawAddressLine1	String		Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.
WithdrawAddressLine2	String		Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.
WithdrawByEmail	String		Indicates whether the customer can withdraw consent by email.
WithdrawByMail	String		Indicates whether the customer can withdraw consent by postal mail.
WithdrawByPhone	String		Indicates whether the customer can withdraw consent by phone.
WithdrawCity	String		Contains the city of the postal address to which a customer can send a consent withdrawal notification.
WithdrawConsequences	String		Indicates the consequences of withdrawing consent.
WithdrawEmail	String		Contains the email address to which a customer can send a consent withdrawal notification.
WithdrawOther	String		Indicates other information need to withdraw consent.
WithdrawPhone	String		Contains the phone number which a customer can call to register consent withdrawal notification.
withdrawPostalCode	String		Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.
WithdrawState	String		Contains the state of the postal address to which a customer can send a consent withdrawal notification.

The Envelope resource provides methods that allow you to manage envelopes.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EnvelopeId supports the '='.
• Status supports the '='.
• StartDateToSearch supports the '='.
• EndDateToSearch supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Envelopes WHERE EnvelopeId = '764c564c-b540-42d1-a667-ccee6813ef7b'
SELECT * FROM Envelopes WHERE StartDateToSearch = '2019-6-24T10:00:04-00:00'
SELECT * FROM Envelopes WHERE StartDateToSearch = '2019-6-24T10:00:04-00:00' AND EndDateToSearch = '2019-8-24T10:00:04-00:00'
SELECT * FROM Envelopes WHERE StartDateToSearch = '2019-6-24T10:00:04-00:00' AND EndDateToSearch = '2019-8-24T10:00:04-00:00' AND Status = 'sent'

Columns

Name	Type	References	Description
EnvelopeId [KEY]	String		The envelope ID.
EnvelopeUri	String		Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
Status	String		Indicates the envelope status. Valid values are: completed - The envelope has been completed and all tags have been signed. created - The envelope is created as a draft. It can be modified and sent later. declined - The envelope has been declined by the recipients. delivered - The envelope has been delivered to the recipients. sent - The envelope is sent to the recipients. signed - The envelope has been signed by the recipients. voided - The envelope is no longer valid and recipients cannot access or sign the envelope.
EnvelopeIdStamping	String		When set to true, Envelope ID Stamping is enabled.
EmailSubject	String		Specifies the subject of the email that is sent to all recipients.
EmailBlurb	String		This is the same as the email body.
DocumentsUri	String		Contains a URI for an endpoint that you can use to retrieve the documents.
DocumentsCombinedUri	String		Contains a URI for an endpoint that you can use to retrieve the combined documents.
AttachmentsUri	String		Contains a URI for an endpoint that you can use to retrieve the attachments.
RecipientsUri	String		Contains a URI for an endpoint that you can use to retrieve the recipients.
CustomFieldsUri	String		Contains a URI for an endpoint to retrieve the custom fields.
CertificateUri	String		Retrieves a URI for an endpoint allowing you to easily retrieve certificate information.
NotificationUri	String		Contains a URI for an endpoint that you can use to retrieve the notifications.
SigningLocation	String		Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
BrandId	String		The unique identifier of a brand.
BrandLock	String		Lock of the brand.
SentDateTime	Datetime		The date and time the envelope was sent.
CompletedDateTime	Datetime		Specifies the date and time this item was completed.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
DeclinedDateTime	Datetime		The date and time the recipient declined the document.
LastModifiedDateTime	Datetime		The date and time the item was last modified.
DeletedDateTime	Datetime		Specifies the data and time the item was deleted.
StatusChangedDateTime	Datetime		The data and time the status changed.
VoidedDateTime	Datetime		The date and time the envelope was voided.
VoidedReason	String		The reason the envelope was voided.
MessageLock	String		When set to true, prevents senders from changing the contents of emailBlurb and emailSubject properties for the envelope.
RecipientsLock	String		When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
PurgeState	String		Shows the current purge state for the envelope. The possible values are: unpurged: There has been no successful request to purge documents. documents_queued: The envelope documents have been added to the purge queue, but have not been purged. documents_dequeued: The envelope documents have been taken out of the purge queue. documents_and_metadata_queued: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. documents_purged: The envelope documents have been successfully purged. documents_and_metadata_purged: The envelope documents and metadata have been successfully purged.
EnableWetSign	String		When set to true, the signer is allowed to print the document and sign it on paper.
EnforceSignerVisibility	String		When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent.
AllowReassign	String		When set to true, the recipient can redirect an envelope to a more appropriate recipient.
AllowMarkup	String		When set to true, Document Markup is enabled for envelope.
Asynchronous	String		When set to true, the envelope is queued for processing and the value of the status property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.
AuthoritativeCopy	String		Specifies whether all documents in this envelope are authoritative copies.
AuthoritativeCopyDefault	String		The default authoritativeCopy setting for documents in this envelope that do not have authoritativeCopy set.
AutoNavigation	String		Specifies whether auto navigation is set for the recipient.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
FolderId	String		Id of the folder where envelope is located.
GetFullInfo	Bool		Id of the folder where envelope is located.

The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId.

For example:

SELECT * FROM EnvelopeTemplates WHERE EnvelopeId = '11dc472d-5675-47b7-ac4e-96c47e473dfe'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• DocumentId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM EnvelopeTemplates WHERE EnvelopeId = 'cd7a0feb-2911-4595-a28e-deaa4a51f55d' AND DocumentId = '3'

Columns

Name	Type	References	Description
EnvelopeId [KEY]	String	Envelopes.EnvelopeId	The envelope ID.
TemplateId	String	Templates.TemplateId	The unique identifier of the template. If this is not provided, DocuSign will generate a value.
Name	String		Name of the template.
DocumentId	String	Documents.DocumentId	Specifies the document ID number.
DocumentName	String		Name of the document.
Applied	Boolean		When set to true, template is applied.
Uri	String		Uri of the template.

Retrieves a list of the folders for the account.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
FolderId [KEY]	String		The ID of the folder being accessed.
ParentFolderId	String		Id of the parent folder.
ParentFolderUri	String		Uri of the parent folder.
Name	String		Name of the folder.
Type	String		Type of the folder.
Uri	String		Uri of the folder.
OwnerUserId	String		Owner id of the folder.
OwnerUserName	String		Owner name of the folder.
OwnerEmail	String		Owner email of the folder.

The GroupBrands resource provides methods that allow you to manage brands in a group.

View Specific Information

In order to make a successful request on this view, you have to specify GroupId.

For example:

SELECT * FROM GroupBrands WHERE GroupId = 6160665

Columns

Name	Type	References	Description
GroupId	Integer	Groups.GroupId	The DocuSign group ID for the group.
BrandId [KEY]	String	AccountBrands.BrandId	Id of the brand.
InternalId	String		Internal Id of the brand.
BrandName	String		Name of the brand.
BrandCompany	String		The name of the company associated with this brand.

The Groups resource provides methods that allow you to manage groups for the account.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• GroupType supports the '='.

For example, the following query is processed server side:

SELECT * FROM Groups WHERE GroupType = 'everyoneGroup'

Columns

Name	Type	References	Description
GroupId [KEY]	Integer		The DocuSign group ID for the group.
GroupName	String		The name of the group.
GroupType	String		The group type.
UsersCount	Integer		Total number of users of the group.
PermissionProfileId	String		The ID of the permission profile associated with the group.

The GroupUsers resource provides methods that allow you to manage the users in a group.

View Specific Information

In order to make a successful request on this view, you have to specify GroupId.

For example:

SELECT * FROM GroupUsers WHERE GroupId = 6071932

Columns

Name	Type	References	Description
GroupId	Integer	Groups.GroupId	The DocuSign group ID for the group.
UserId [KEY]	String	Users.UserId	Id of the user account
UserName	String		Name of the user account
Email	String		Email of the user account
UserType	String		Type of the user account
UserStatus	String		Status of the user account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
Uri	String		Uri of the user account
LoginStatus	String		Status of login.
SendActivationEmail	Boolean		When set to true, an activation email can be sent.
ActivationAccessCode	String		Activation code for access.

The Locks resource provides methods that allow you to manage locks on an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

For example:

SELECT * FROM Locks WHERE Type = 'templates' AND Id = '22093429-0c89-47d3-a984-8b919768b963'
SELECT * FROM Locks WHERE Type = 'envelopes' AND Id = '03ea05dc-b5ba-45d2-8b0c-3bf0f5ae8d59'

Columns

Name	Type	References	Description
Id [KEY]	String	Envelopes.EnvelopeId or Templates.TemplateId	Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
LockedByUserName	String		Name of the user.
LockedByUserId	String		The user ID of the user being accessed.
LockedByUserEmail	String		Email of the user.
LockedByUri	String		Uri of the user.
LockedByApp	String		Specifies the friendly name of the application that is locking the envelope.
LockType	String		The type of envelope lock. Currently
LockToken	String		A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.
LockedUntilDateTime	Datetime		The datetime until the envelope lock expires.
LockDurationInSeconds	String		Sets the time, in seconds, until the lock expires when there is no activity on the envelope.
UseScratchPad	String		Indicates whether a scratchpad is used for editing information.

The PowerForms resource provides methods that allow you to manage power forms.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• PowerFormId supports the '='.

For example, the following query is processed server side:

SELECT * FROM PowerForms WHERE PowerFormId = '3caf8d81-1c18-4ff6-bc1b-39e4ab8c2692'

Columns

Name	Type	References	Description
PowerFormId [KEY]	String		The unique identifier of the power form.
Name	String		PowerForm name.
PowerFormUrl	String		Contains a URI for an endpoint that you can use to retrieve the PowerForms.
PowerFormV2Url	String		Contains V2 URI for an endpoint that you can use to retrieve the PowerForms.
Uri	String		Uri of the powerforms.
TemplateId	String	Templates.TemplateId	The unique identifier of the template. If this is not provided, DocuSign will generate a value.
TemplateName	String		Name of the template.
CreatedBy	String		Creator name.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
SenderName	String		Name of the sender.
SenderUserId	String		User Id of the sender.
EmailBody	String		Email body of the message sent to the recipient.
EmailSubject	String		The subject of the email that is sent to all recipients.
SigningMode	String		Specifies the mode of the signing.
Instructions	String		Specifies the PowerForm instructions.
IsActive	Boolean		Indicates the status of the PowerForm.
TimesUsed	Integer		Indicates number of times the item was used.
LastUsed	Datetime		Indicates the date and time the item was used for the last time.
MaxUseEnabled	Boolean		The maximum of using times for the item.
UsesRemaining	Integer		The remaining number of times the item can be used.
LimitUseIntervalEnabled	Boolean		Status of the LimitUseInterval.
LimitUseInterval	String		Specifies the interval of the uses limit.
LimitUseIntervalUnits	String		Unit type of the LimitUseInterval.

The Recipients resource allows you manage the recipients of an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

For example:

SELECT * FROM Recipients WHERE Type = 'templates' AND Id = '22093429-0c89-47d3-a984-8b919768b963'
SELECT * FROM Recipients WHERE Type = 'envelopes' AND Id = '03ea05dc-b5ba-45d2-8b0c-3bf0f5ae8d59'

Columns

Name	Type	References	Description
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
Id	String		Id of the Envelope or Template.
RecipientId [KEY]	Integer		Unique Id for the recipient.
RecipientIdGuid	String		Id guid of the recipient.
RecipientType	String		Type of the recipient.
UserId	String		The user ID of the user being accessed.
Name	String		Name of the recipient.
Email	String		Email of the recipient.
RoleName	String		Optional element. Specifies the role name associated with the recipient.
Note	String		A note sent to the recipient in the signing email. This note is unique to this recipient.
CreationReason	String		Reason of the creation.
ClientUserId	String		Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.
AccessCode	String		If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
RequireIdLookup	Boolean		When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
DeliveryMethod	String		Method of the delivery.
DeliveredDateTime	Datetime		Date and time of the delivery.
SignedDateTime	Datetime		The date and time the envelope was signed.
SigningGroupId	String		The display Id for the signing group.
SigningGroupName	String		The display name for the signing group.
CanSignOffline	Boolean		When set to true, specifies that the signer can perform the signing ceremony offline.
Status	String		Recipient status.

The RecipientTabs resource provides methods that let you add, update, and delete tabs from an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

For example:

SELECT * FROM RecipientTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND RecipientId = 7296558
SELECT * FROM RecipientTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND RecipientId = 44407249

Columns

Name	Type	References	Description
Id	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
DocumentId	String	Documents.DocumentId	Specifies the document ID number that the tab is placed on.
RecipientId	Integer	Recipients.RecipientId	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
TabId [KEY]	String		The unique identifier for the tab.
CustomTabId	String	CustomTabs.CustomTabId	The DocuSign generated custom tab ID for the custom tab to be applied.
Name	String		Name of the tab.
Status	String		Status of the tab.
TabLabel	String		The label string associated with the tab.
Font	String		The font to be used for the tab value.
Bold	Boolean		When set to true, the information in the tab is bold.
Italic	Boolean		When set to true, the information in the tab is italic.
Underline	Boolean		When set to true, the information in the tab is underlined.
FontColor	String		The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White.
FontSize	String		The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72.
TabOrder	String		A positive integer that sets the order the tab is navigated to during signing.
PageNumber	Integer		Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
XPosition	Integer		This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
YPosition	Integer		This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
AnchorString	String		Specifies the anchor string.
AnchorXOffset	String		Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
AnchorYOffset	String		Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
AnchorUnits	String		Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
AnchorIgnoreIfNotPresent	String		When set to true, this tab is ignored if anchorString is not found in the document.
TemplateLocked	Boolean		When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
TemplateRequired	Boolean		When set to true, the sender may not remove the recipient. Used only when working with template recipients.
ConditionalParentLabel	String		For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
ConditionalParentValue	String		For conditional fields, this is the value of the parent tab that controls the tab's visibility.

Returns data from a sample table.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
SigningGroupId [KEY]	String		Id of the signing group.
GroupName	String		The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.
GroupType	String		The group type.
GroupEmail	String		Email of the group.
Created	String		The UTC DateTime when the workspace user authorization was created.
CreatedBy	String		Creator of the group.
Modified	Datetime		The UTC DateTime when the workspace user authorization was modified.
ModifiedBy	String		Modifier of the group.

The SigningGroupUsers resource provides methods that allow you to manage users in Signing Groups.

View Specific Information

In order to make a successful request on this view, you have to specify SigningGroupId.

For example:

SELECT * FROM SigningGroupUsers WHERE SigningGroupId = '6071932'

Columns

Name	Type	References	Description
SigningGroupId	String	SigningGroups.SigningGroupId	Id of the signing group.
UserName	String		The name of the group member.
Email [KEY]	String		The email of the group member.

The Template resource provides methods that allow you to manage templates.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• TemplateId supports the '='.
• FolderId supports the '=' and 'IN'. In order to filter by FolderId, showCustomFiled property must be set to false.
• FolderName supports the '='. In order to filter by FolderName, showCustomFiled property must be set to false.

For example, the following queries are processed server side:

SELECT * FROM Templates WHERE TemplateId = '5fe47399-31e9-4ddc-bbd1-5200760e4658'
SELECT * FROM Templates WHERE FolderId = '7137682d-f33c-4425-96a2-d556389df80f'
SELECT * FROM Templates WHERE FolderId IN ('7137682d-f33c-4425-96a2-d556389df80f', 'ff7cc98e-4502-4009-93ce-8d3ad96485a6')
SELECT * FROM Templates WHERE FolderName = 'testTemplate'

Columns

Name	Type	References	Description
TemplateId [KEY]	String		Id of the template.
Name	String		Name of the template.
Password	String		Password of the template.
Description	String		Description of the template.
Shared	String		When set to true, this template is shared.
Created	Datetime		The date and time the item was created.
LastModified	Datetime		The date and time the item was last modified.
PageCount	String		Number of pages.
Uri	String		Contains a URI to retrieve the templates.
FolderName	String		Name of the template folder.
FolderId	String	Folders.FolderId	Id of the folder.
FolderUri	String		Uri of the folder.
OwnerUserName	String		Name of the user.
OwnerEmail	String		Email of the user.
OwnerUserId	String		Id of the user.
EmailBlurb	String		Blurb of the email
EmailSubject	String		Subject of the email.
AllowReassign	String		When set to true, the recipient can redirect an envelope to a more appropriate recipient.
AuthoritativeCopy	String		Specifies whether all documents in this template are authoritative copies. A document can set its own authoritativeCopy property to override this value.
EnableWetSign	String		When set to true, the signer is allowed to print the document and sign it on paper.
EnforceSignerVisibility	String		When set to true, documents with tabs can only be viewed by signers that have a tab on that document.

The UserInfo resource provides methods that allow you to manage your current user info.

Columns

Name	Type	References	Description
AccountId [KEY]	String		The ID of the account.
AccountName	String		The name associated with this account.
Url	String		The base URI that is used for making API calls on behalf of this account.
IsDefault	Boolean		If true, this account is the account holder's default account.

The Users resource provides methods that allow you to manage users for an account.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Users supports the '='.
• Email supports the '='.
• UserStatus supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE UserId = '9degfd10-2704-4af4-ae3e-ac6r4d4bcf0a'
SELECT * FROM Users WHERE Email = '[email protected]'
SELECT * FROM Users WHERE UserStatus = 'Active'
SELECT * FROM Users WHERE UserStatus = 'Active' AND Email = '[email protected]'"

Columns

Name	Type	References	Description
UserId [KEY]	String		The user ID of the user being accessed.
UserName	String		The user's full name.
UserStatus	String		Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
UserType	String		The user type.
IsAdmin	Boolean		Determines if the feature set is actively set as part of the plan.
Email	String		The user's email address.
Uri	String		Uri of the user.
PermissionProfileId	Integer		User's permission profile id.
permissionProfileName	String		User's permission profile name.
JobTitle	String		Title of the job.
Title	String		Salutation for the user, such as Ms, Dr, Capt., etc.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
LastLogin	Datetime		The date-time when the user last logged on to the system.

The UserSignatures resource provides methods that allow you manage the intials and signature images for a user.

View Specific Information

In order to make a successful request on this view, you have to specify UserId.

For example:

SELECT * FROM UserSignatures WHERE UserId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a'

Columns

Name	Type	References	Description
UserId	String	Users.UserId	The user ID of the user being accessed.
SignatureId [KEY]	String		Specifies the signature ID associated with the signature name.
SignatureImageUri	String		Contains the URI for an endpoint that you can use to retrieve the signature image.
InitialsImageUri	String		Contains the URI for an endpoint that you can use to retrieve the initials image.
SignatureInitials	String		The initials associated with the signature.
UserSignatureName	String		Specifies the user signature name.
SignatureType	String		Type of the signature.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
AdoptedDateTime	Datetime		The date and time the user adopted their signature.
IsDefault	Boolean		Specifies if the signature is default or not.

The Workspaces resource provides methods that allow you to manage workspaces.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
WorkspaceId [KEY]	String		The id of the workspace, always populated.
WorkspaceName	String		The name of the workspace.
WorkspaceUri	String		The relative URI that may be used to access the workspace.
WorkspaceBaseUrl	String		The relative URL that may be used to access the workspace.
Created	Datetime		The UTC DateTime when the workspace user authorization was created.
LastModified	Datetime		Utc date and time the comment was last updated (can only be done by creator.)
Status	String		Workspace status.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
AccountId	AccountId of the currently authenticated user.
DirectoryRetrievalDepth	The depth to scan for available folders.
IncludeCustomFields	Set to true if you want to retrieve custom fields values for an envelope or template.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
URL	Base API url associated with your account.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.
UseSandbox	Set to true if you you are using sandbox account.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to DocuSign and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\DocuSign Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
AccountId	AccountId of the currently authenticated user.
DirectoryRetrievalDepth	The depth to scan for available folders.
IncludeCustomFields	Set to true if you want to retrieve custom fields values for an envelope or template.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
URL	Base API url associated with your account.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.
UseSandbox	Set to true if you you are using sandbox account.

AccountId of the currently authenticated user.

Remarks

If it's not specified, it will be set by default. Please query the UserInfo view if you want to set it manually.

The depth to scan for available folders.

Remarks

This property must be set in the connection string or the driver will use a default of Depth=-1 (specifies that all subfolders are scanned).

Set to true if you want to retrieve custom fields values for an envelope or template.

Remarks

Set to true if you want to retrieve custom fields values for an envelope or template.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

Base API url associated with your account.

Remarks

If it's not specified, it will be set by default. Please query UserInfo view if you want to set it manually.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Account WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Set to true if you you are using sandbox account.

Remarks

Set to true if you you are using sandbox account.