DocuSign Connector 1.1 Reference | MuleSoft Documentation
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Service Information Get Resource Information
`<docusign:get-v21>`
Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources, for example, https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL, for example: `https://demo.docusign.net/restapi/help` lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.
This operation makes an HTTP GET request to the /v2.1 endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Charges Get Account Billing Charges
`<docusign:get-v21-accounts-billing-charges-by-account-id>`
Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_charges endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Include charges | Specifies which billing charges to return. Valid values are: * envelopes * seats  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Invoices Get Billing Invoices
`<docusign:get-v21-accounts-billing-invoices-by-account-id>`
Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_invoices endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
From date | Specifies the date/time of the earliest invoice in the account to retrieve.  
Specifies the date/time of the latest invoice in the account to retrieve.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Invoices Get Billing Invoice
`<docusign:get-v21-accounts-billing-invoices-by-account-id-invoice-id>`
Retrieves the specified invoice.
**Note** : If the `pdfAvailable` property in the response is set to **true** , you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`.
Privileges required: account administrator
The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_invoices/{invoiceId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Invoice Id | Invoice Id  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Invoices Get Billing Invoices Past Due
`<docusign:get-v21-accounts-billing-invoices-past-due-by-account-id>`
Returns a list past due invoices for the account and notes if payment can be made through the REST API.
Privileges Required: account administrator
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_invoices_past_due endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Payments Get Payment List
`<docusign:get-v21-accounts-billing-payments-by-account-id>`
Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.
Privileges required: account administrator
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_payments endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
From date | Specifies the date/time of the earliest payment in the account to retrieve.  
Specifies the date/time of the latest payment in the account to retrieve.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Payments Get Payment
`<docusign:get-v21-accounts-billing-payments-by-account-id-payment-id>`
Retrieves the information for a specified payment. Privileges required: account administrator This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_payments/{paymentId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Payment Id | Payment Id  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Plan Get Billing Plan
`<docusign:get-v21-accounts-billing-plan-by-account-id>`
Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to **false**.
The response returns the billing plan information, including the currency code, for the plan.
**Note** : When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_plan endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Include credit card information | When set to **true** , payment information including credit card information will show in the return.  
Include metadata | When set to **true** , the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` is added to the `billingAddress` information.  
Include successor plans | When set to **true** , excludes successor information from the response.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Plan Get Credit Card Info
`<docusign:get-v21-accounts-billing-plan-credit-card-by-account-id>`
This method returns information about a credit card associated with an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_plan/credit_card endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Plan Get Downgrade Request Billing Info
`<docusign:get-v21-accounts-billing-plan-downgrade-by-account-id>`
Billing Plan Get Downgrade Request Billing Info This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_plan/downgrade endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Brands Get Brands
`<docusign:get-v21-accounts-brands-by-account-id>`
This method returns details about all of the brands associated with an account, including the default brand profiles.
**Note** : Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/brands endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Exclude distributor brand | When **true** , excludes distributor brand information from the response set.  
Include logos | When **true** , the URIs for the logos associated with the brand are included in the response.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Brand Get Brand
`<docusign:get-v21-accounts-brands-by-account-id-brand-id>`
This method returns details about an account brand.
**Note** : Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/brands/{brandId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Brand Id | The ID of the brand.  
Include external references | When **true** , the landing pages and links associated with the brand are included in the response.  
Include logos | When **true** , the URIs for the logos associated with the brand are included in the response.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Brand Export Get Brand Export File
`<docusign:get-v21-accounts-brands-file-by-account-id-brand-id>`
This method exports information about a brand to an XML file.
**Note** : Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/brands/{brandId}/file endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Brand Id | The ID of the brand.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Brand Logo Get Brand Logo
`<docusign:get-v21-accounts-brands-logos-by-account-id-brand-id-logo-type>`
This method returns a specific logo that is used in a brand.
**Note** : Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Brand Id | The ID of the brand.  
Logo Type | The type of logo. Valid values are: - `primary` - `secondary` - `email`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Brand Resources Get Brand Resources List
`<docusign:get-v21-accounts-brands-resources-by-account-id-brand-id>`
This method returns metadata about the branding resources that are associated with an account.
**Note** : Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/brands/{brandId}/resources endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Brand Id | The ID of the brand.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Brand Resources Get Brand Resources
`<docusign:get-v21-accounts-brands-resources-by-account-id-brand-id-resource-content-type>`
This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.
**Important** : When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.
**Note** : Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Brand Id | The ID of the brand.  
Resource Content Type | The type of brand resource file to return. Valid values are: - `sending` - `signing` - `email` - `signing_captive`  
langcode | The ISO 3166-1 alpha-2 codes for the languages that the brand supports.  
Return master | Specifies which resource file data to return. When **true** , only the master resource file is returned. When **false** , only the elements that you modified are returned.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Bulk Send V2Batch Get Bulk Send Batches
`<docusign:get-v21-accounts-bulk-send-batch-by-account-id>`
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/bulk_send_batch endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Batch ids | Batch ids  
The maximum number of results to return.  
Start position | The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.  
The status of the item.  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Bulk Send V2Batch Get Bulk Send Batch Status
`<docusign:get-v21-accounts-bulk-send-batch-by-account-id-bulk-send-batch-id>`
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Bulk Send Batch Id | Bulk Send Batch Id  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  *
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Bulk Send V2CRUD Get Bulk Send Lists
`<docusign:get-v21-accounts-bulk-send-lists-by-account-id>`
This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/bulk_send_lists endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Bulk Send V2CRUD Get Bulk Send List
`<docusign:get-v21-accounts-bulk-send-lists-by-account-id-bulk-send-list-id>`
This method returns all of the details associated with a specific bulk send list that belongs to the current user. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Bulk Send List Id | The GUID of the bulk send list. This property is created after you post a new bulk send list.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Accounts Get Account
`<docusign:get-v21-accounts-by-account-id>`
Retrieves the account information for the specified account.
**Response** The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Include account settings | When set to **true** , includes account settings (defined by the [`accountSettings`](https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/create/#account-settings) property) in the response. If you omit this parameter, the default behavior is **false**.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  *
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Chunked Uploads Get Chunked Upload
`<docusign:get-v21-accounts-chunked-uploads-by-account-id-chunked-upload-id>`
Returns the details (but not the content) about a chunked upload.
**Note** : You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Chunked Upload Id | The ID of the chunked upload.  
(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Connect Get Connect Configs
`<docusign:get-v21-accounts-connect-by-account-id>`
Retrieves all the DocuSign Custom Connect definitions for the specified account.
**Note** : Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Connect Get Connect Config
`<docusign:get-v21-accounts-connect-by-account-id-connect-id>`
Retrieves the information for the specified DocuSign Connect configuration.
**Note** : Connect must be enabled for your account to use this function.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/{connectId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Connect Id | The ID of the custom Connect configuration being accessed.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  *
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Connect Failures Get Connect Logs
`<docusign:get-v21-accounts-connect-failures-by-account-id>`
Retrieves the Connect failure log information. You can use this log to determine which envelopes failed to post, to create a republish request. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/failures endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
From date | The start date for a date range in UTC DateTime format. **Note** : If this property is null, no date filtering is applied.  
The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. **Note** : If this property is null, the value defaults to the current date.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Connect Log Get Connect Logs
`<docusign:get-v21-accounts-connect-logs-by-account-id>`
Retrieves a list of connect log entries for your account.
**Note** : The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/logs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
From date | The start date for a date range in UTC DateTime format. **Note** : If this property is null, no date filtering is applied.  
The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. **Note** : If this property is null, the value defaults to the current date.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Connect Log Get Connect Log
`<docusign:get-v21-accounts-connect-logs-by-account-id-log-id>`
Retrieves the specified Connect log entry for your account.
**Note** : The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/logs/{logId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
The ID of the Connect log entry.  
Additional info | When set to **true** , the response includes the `connectDebugLog` information.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Connect Get Connect Users
`<docusign:get-v21-accounts-connect-users-by-account-id-connect-id>`
Returns users from the configured Connect service. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/{connectId}/users endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Connect Id | The ID of the custom Connect configuration being accessed.  
List included users | List included users  
Optional. Number of items to return.  
Email substring | Filters returned user records by full email address or a substring of email address.  
User name substring | Filters results based on a full or partial user name. **Note** : When you enter a partial user name, you do not use a wildcard character.  
Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled  
Start position | The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Consumer Disclosure Get Consumer Disclosure
`<docusign:get-v21-accounts-consumer-disclosure-by-account-id>`
Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. The default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties. To set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/consumer_disclosure endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Lang Code | (Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Consumer Disclosure Get Consumer Disclosure Lang Code
`<docusign:get-v21-accounts-consumer-disclosure-by-account-id-lang-code>`
Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. To set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.
**Note** : The text of the default disclosure is always in English, but if you are using a custom disclosure and have created versions of it in different signer languages, you can use the `langCode` parameter to specify the signer language version that you want to retrieve.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/consumer_disclosure/{langCode} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Lang Code | (Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Contacts Get Contact By Id
`<docusign:get-v21-accounts-contacts-by-account-id-contact-id>`
This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the `cloud_provider` query parameter. By default, contacts are retrieved from the DocuSign account’s default address book. To return a specific contact, use the `contactId` query parameter. To return all contacts associated with an account, omit this parameter. [CloudStorage]: /esign-rest-api/reference/CloudStorage/
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/contacts/{contactId} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Contact Id | The ID of a contact person in the account''s address book.  
Cloud provider | (Optional) The cloud provider from which to retrieve the contacts. Valid values are: - `rooms` - `docusignCore` (default)  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Account Custom Fields Get Account Custom Fields
`<docusign:get-v21-accounts-custom-fields-by-account-id>`
This method returns a list of the envelope and document custom fields associated with an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/custom_fields endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream
### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Account Custom Fields Get Account Custom Fields
`<docusign:get-v21-accounts-custom-fields-by-account-id>`
This method returns a list of the envelope and document custom fields associated with an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/custom_fields endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Attachments Get Attachments
`<docusign:get-v21-accounts-envelopes-attachments-by-account-id-envelope-id>`
Gets attachments. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Attachments Get Attachment
`<docusign:get-v21-accounts-envelopes-attachments-by-account-id-envelope-id-attachment-id>`
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Attachment Id | The unique identifier for the attachment.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Audit Events Get Audit Events
`<docusign:get-v21-accounts-envelopes-audit-events-by-account-id-envelope-id>`
Gets the envelope audit events for the specified envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
## Audit Events Get Audit Events
`<docusign:get-v21-accounts-envelopes-audit-events-by-account-id-envelope-id>`
Gets the envelope audit events for the specified envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Envelopes Get Envelopes
`<docusign:get-v21-accounts-envelopes-by-account-id>`
Retrieves a list of envelopes that match your request. A large set of optional filters let you filter by date, by envelope ID, or by status codes. Your request must include one or more of the following parameters:
  * `from_date`
  * `envelope_ids`
  * `transaction_ids`
Getting envelope status using `transaction_ids` is useful for offline signing situations where it can be used determine if an envelope was created or not. It can be used for the cases where a network connection was lost, before the envelope status could be returned.
To avoid unnecessary database queries, the DocuSign signature platform first checks requests to ensure that the filter set supplied does not result in a zero-size response before querying the database. For example, for a request with a `from_to_status` of `delivered` and a current `status` of `created,sent`, DocuSign will always return an empty list. This is because the request translates to: find the envelopes that were delivered between the `from_date` and `to_date` dates that have a current status of `created` or `sent`. Since an envelope that has been delivered can never have a status of `created` or `sent`, a zero-size response would be generated.
In this case, DocuSign does not query the database and returns an empty list immediately. The following table shows the valid current envelope statuses (`status` parameter) for the different status qualifiers (`from_to_status` parameter) in the request.
If the status and status qualifiers in the API request do not contain any of the values shown in the Valid Current Statuses column, then an empty list is returned. Client applications should check that the statuses (`status` parameter) they are requesting make sense for a given `from_to_status` parameter value.
Status Qualifier (`from_to_status`) | Effective Status Qualifier | Valid Current Statuses  
---|---|---  
any (changed) | StatusChanged | any, created, sent, delivered, signed, completed, declined, voided, deleted  
any, created, sent, delivered, signed, completed, declined, voided, deleted  
any, sent, delivered, signed, completed, declined, voided, deleted  
delivered | StatusChanged | any, delivered, signed, completed, declined, voided, deleted  
StatusChanged | any, signed, completed, declined, voided, deleted  
completed | Completed | any, completed, declined, voided, deleted  
declined | StatusChanged | any, declined, voided, deleted  
timedout always return zero results | StatusChanged | any, voided, deleted  
any, voided, deleted  
StatusChanged  
### Extraneous results
In some cases, a request for a specific envelope status will include envelopes with additional statuses. For example, in a request with a `from_date` of 2017-01-01, a `to_date` of 2017-01-07 and the status qualifier (`from_to_status`) set to `delivered`, the response set might contain envelopes that were created during that time period, but not delivered during the time period. As a workaround, check the envelope status values in the result set as needed.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Include purge information | When set to **true** , information about envelopes that have been deleted is included in the response.  
Continuation token | A token returned in the response to a previous API call that is used to resume a search query from a specific point.  
Optional. Number of items to return. Currently there is no implicit maximum limit of the number of items that can be returned.  
From to status | The envelope status that you are checking for. Possible values are: - `Changed` (default) - `Completed` - `Created` - `Declined` - `Deleted` - `Delivered` - `Processing` - `Sent` - `Signed` - `TimedOut` - `Voided` For example, if you specify `Changed`, this method returns a list of envelopes that changed status during the `from_date` to `to_date` time period.  
Limit results to envelopes sent by the account user with this email address. `user_name` must be given as well, and both `email` and `user_name` must refer to an existing account user.  
Search text | Free text search criteria that you can use to filter the list of envelopes that is returned.  
Ac status | Specifies the Authoritative Copy Status for the envelopes. The possible values are: - `Unknown` - `Original` - `Transferred` - `AuthoritativeCopy` - `AuthoritativeCopyExportPending` - `AuthoritativeCopyExported` - `DepositPending` - `Deposited` - `DepositedEO` - `DepositFailed`  
Envelope ids | Comma separated list of `envelopeId` values.  
Folder types | A comma-separated list of folder types you want to retrieve envelopes from. Valid values are: - `normal` - `inbox` - `sentitems` - `draft` - `templates`  
powerformids | A comma-separated list of `PowerFormId` values.  
The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account.  
Reserved for DocuSign.  
Requester date format | Requester date format  
User filter | Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, `user_filter=sender`.) Valid values are: - `sender` - `recipient` - `recipient_only`  
Returns envelopes in either ascending (`asc`) or descending (`desc`) order.  
A comma-separated list of current envelope statuses to included in the response. Possible values are: * `completed` * `created` * `declined` * `deleted` * `delivered` * `processing` * `sent` * `signed` * `timedout` * `voided` The `any` value is equivalent to any status.  
Intersecting folder ids | A comma-separated list of folders that you want to get envelopes from. Valid values are: - `normal` - `inbox` - `sentitems` - `draft` - `templates`  
Query budget | The time in seconds that the query should run before returning data.  
Order by | Sorts results according to a specific property. Valid values are: - `last_modified` - `action_required` - `created` - `completed` - `envelope_name` - `expire` - `sent` - `signer_list` - `status` - `subject` - `user_name` - `status_changed` - `last_modified`  
Specifies additional information to return about the envelopes. Enter a comma-separated list, such as `tabs,recipients`. Valid values are: - `custom_fields`: The custom fields associated with the envelope. - `documents`: The documents associated with the envelope. - `attachments`: The attachments associated with the envelope. - `extensions`: Information about the email settings associated with the envelope. - `folders`: The folders where the envelope exists. - `recipients`: The recipients associated with the envelope. - `powerform`: The PowerForms associated with the envelope. - `payment_tabs`: The payment tabs associated with the envelope.  
Custom field | Optional. Specifies a envelope custom field name and value searched for in the envelopes. Format: `custom_envelope_field_name=desired_value` Example: If you have an envelope custom field named "Region" and you want to search for all envelopes where the value is "West" you would use set this parameter to `Region=West`.  
From date | Specifies the date and time to start looking for status changes. This parameter is required unless `envelopeIds` or `transactionIds` are set. Although you can use any date format supported by the .NET system library’s [`DateTime.Parse()`][msoft] function, DocuSign recommends using [ISO 8601][] format dates with an explicit time zone offset If you do not provide a time zone offset, the method uses the server’s time zone. For example, the following dates and times refer to the same instant: * `2017-05-02T01:44Z` * `2017-05-01T21:44-04:00` * `2017-05-01T18:44-07:00` [msoft]: https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601  
Excludes information from the response. Enter as a comma-separated list (, for example, `folders,powerforms`). Valid values are: - `recipients` - `powerforms` - `folders`  
Last queried date | Returns envelopes that were modified prior to the specified date and time. Example: `2020-05-09T21:56:12.2500000Z`  
Folder ids | Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder Guids or the following values: - `awaiting_my_signature` - `completed` - `draft` - `drafts` - `expiring_soon` - `inbox` - `out_for_signature` - `recyclebin` - `sentitems` - `waiting_for_others`  
Cdse mode | Reserved for DocuSign.
Excludes information from the response. Enter as a comma-separated list (, for example, `folders,powerforms`). Valid values are: - `recipients` - `powerforms` - `folders`  
Last queried date | Returns envelopes that were modified prior to the specified date and time. Example: `2020-05-09T21:56:12.2500000Z`  
Folder ids | Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder Guids or the following values: - `awaiting_my_signature` - `completed` - `draft` - `drafts` - `expiring_soon` - `inbox` - `out_for_signature` - `recyclebin` - `sentitems` - `waiting_for_others`  
Cdse mode | Reserved for DocuSign.  
User name | Limit results to envelopes sent by the account user with this user name. `email` must be given as well, and both `email` and `user_name` must refer to an existing account user.  
Start position | This value is supported and currently has no implicit maximum items.  
Transaction ids | A comma-separated list of envelope transaction IDs. Transaction IDs are only valid for seven days.  
Specifies the date and time to stop looking for status changes. The default is the current date and time. Although you can use any date format supported by the .NET system library’s [`DateTime.Parse()`][msoft] function, DocuSign recommends using [ISO 8601][] format dates with an explicit time zone offset If you do not provide a time zone offset, the method uses the server’s time zone. For example, the following dates and times refer to the same instant: * `2017-05-02T01:44Z` * `2017-05-01T21:44-04:00` * `2017-05-01T18:44-07:00` [msoft]: https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Envelopes Get Envelope
`<docusign:get-v21-accounts-envelopes-by-account-id-envelope-id>`
Retrieves the overall status for the specified envelope. To get the status of a list of envelopes, use Envelope: listStatusChanges .
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Advanced update | When **true** , envelope information can be added or modified.  
Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are: - `custom_fields`: The custom fields associated with the envelope. - `documents`: The documents associated with the envelope. - `attachments`: The attachments associated with the envelope. - `extensions`: Information about the email settings associated with the envelope. - `folders`: The folder where the envelope exists. - `recipients`: The recipients associated with the envelope. - `powerform`: The PowerForms associated with the envelope. - `tabs`: The tabs associated with the envelope. - `payment_tabs`: The payment tabs associated with the envelope.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Comments Get Comments Transcript
`<docusign:get-v21-accounts-envelopes-comments-transcript-by-account-id-envelope-id>`
Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.
**Note** : Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**).
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
encoding | (Optional) The encoding to use for the file.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Custom Fields Get Custom Fields
`<docusign:get-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>`
Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a premade list.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Documents Get Documents
`<docusign:get-v21-accounts-envelopes-documents-by-account-id-envelope-id>`
Retrieves a list of documents associated with the specified envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Include tabs | When set to **true** , information about the tabs associated with the documents are included in the response.  
Shared user ID | The ID of a shared user that you want to impersonate to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console).  
Include metadata | When set to **true** , the response includes metadata that indicates which properties the sender can edit.  
Include document size | Include document size  
Documents by userid | When set to **true** , allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.  
Recipient ID | Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this to work.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Documents Get Document
`<docusign:get-v21-accounts-envelopes-documents-by-account-id-envelope-id-document-id>`
Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | This parameter takes the following special keywords: - `combined`: Retrieves a PDF file that contains the combined content of all of the documents. If the account option **Attach certification of completion to envelope** is on, then the Certificate of Completion is also included in the PDF file. You set this account option in the Admin tool on the **Signing Settings** screen, or by setting the `attachCompletedEnvelope` property in the `accountSettings` object to **true**. - `archive`: Retrieves a ZIP archive that contains all of the PDF documents and the Certificate of Completion.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
certificate | When set to **false** , the envelope signing certificate is removed from the download.  
Shared user ID | The ID of a shared user that you want to impersonate to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console).  
When set to **true** , the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.  
encoding | Reserved for DocuSign.  
Documents by userid | When set to **true** , allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.  
language | Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).  
Show changes | When set to **true** , any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.  
Recipient ID | Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this functionality to work.  
watermark | When set to **true** , the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Document Fields Get Document Fields
`<docusign:get-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>`
Retrieves the custom document field information from an existing envelope document. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Responsive Html Get Envelope Document Html Definitions
`<docusign:get-v21-accounts-envelopes-documents-html-definitions-by-account-id-envelope-id-document-id>`
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Pages Get Page Images
`<docusign:get-v21-accounts-envelopes-documents-pages-by-account-id-envelope-id-document-id>`
Returns images of the pages in a document for display based on the parameters that you specify. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Max width | Sets the maximum width of the returned images in pixels.  
The maximum number of results to return.  
Max height | Sets the maximum height of the returned images in pixels.  
The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.  
If **true** , using cache is disabled and image information is retrieved from a database. **True** is the default value.  
Show changes | If **true** , changes display in the user interface.  
Start position | The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Pages Get Page Image
`<docusign:get-v21-accounts-envelopes-documents-pages-page-image-by-account-id-envelope-id-document-id-page-number>`
Returns an image of a page in a document for display. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Page Number | The page number being accessed.  
Sets the dots per inch (DPI) for the returned image.  
Max height | Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.  
Max width | Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.  
Show changes | When **true** , changes display in the user interface.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Tabs Get Page Tabs
`<docusign:get-v21-accounts-envelopes-documents-pages-tabs-by-account-id-envelope-id-document-id-page-number>`
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Page Number | The page number being accessed.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Tabs Get Document Tabs
`<docusign:get-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>`
This method returns the tabs associated with a document. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Page numbers | Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs. Example: `page_numbers=2,6` Note: You can only enter individual page numbers, and not a page range.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Templates Get Document Templates
`<docusign:get-v21-accounts-envelopes-documents-templates-by-account-id-envelope-id-document-id>`
Retrieves the templates associated with a document in the specified envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
A comma-separated list that limits the results. Valid values are: * `applied` * `matched`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Email Settings Get Email Settings
`<docusign:get-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>`
Retrieves the email override settings for the specified envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Form Data Get Form Data
`<docusign:get-v21-accounts-envelopes-form-data-by-account-id-envelope-id>`
This method downloads the envelope and field data from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.
**Note** : To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Responsive Html Get Envelope Html Definitions
`<docusign:get-v21-accounts-envelopes-html-definitions-by-account-id-envelope-id>`
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  *
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Lock Get Envelope Lock
`<docusign:get-v21-accounts-envelopes-lock-by-account-id-envelope-id>`
Retrieves general information about an envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This information enables users to recover a lost editing session token and the `X-DocuSign-Edit` header.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Notification Get Envelopes Envelope Id Notification
`<docusign:get-v21-accounts-envelopes-notification-by-account-id-envelope-id>`
Retrieves the envelope notification, reminders and expirations, information for an existing envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Get Recipients
`<docusign:get-v21-accounts-envelopes-recipients-by-account-id-envelope-id>`
Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Include anchor tab locations | When set to **true** and `include_tabs` value is set to **true** , all tabs with anchor tab properties are included in the response.  
Include extended | When set to **true** , the extended properties are included in the response.  
Include metadata | Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates).  
Include tabs | When set to **true** , the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (**false**).  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id
`<docusign:get-v21-accounts-envelopes-recipients-consumer-disclosure-by-account-id-envelope-id-recipient-id>`
Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify. The default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties. To set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Recipient Id | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.  
Lang Code | (Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id Lang Code
`<docusign:get-v21-accounts-envelopes-recipients-consumer-disclosure-by-account-id-envelope-id-recipient-id-lang-code>`
Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient’s language settings. To set the language of the disclosure that you want to retrieve, specify the `langCode` as either a path or query parameter.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Lang Code | (Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.  
Recipient Id | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.  
Lang Code | (Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Get Recipient Document Visibility
`<docusign:get-v21-accounts-envelopes-recipients-document-visibility-by-account-id-envelope-id-recipient-id>`
This method returns information about document visibility for a recipient. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Recipient Id | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Get Recipient Initials Image
`<docusign:get-v21-accounts-envelopes-recipients-initials-image-by-account-id-envelope-id-recipient-id>`
Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.
The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Recipient Id | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.  
Include chrome | The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Get Recipient Signature
`<docusign:get-v21-accounts-envelopes-recipients-signature-by-account-id-envelope-id-recipient-id>`
Retrieves signature information for a signer or sign-in-person recipient. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Recipient Id | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Get Recipient Signature Image
`<docusign:get-v21-accounts-envelopes-recipients-signature-image-by-account-id-envelope-id-recipient-id>`
Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.
The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.
The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don’t properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Recipient Id | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.  
Include chrome | When set to **true** , the response includes the chromed version of the signature image.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Get Recipient Tabs
`<docusign:get-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>`
Retrieves information about the tabs associated with a recipient. You can make a single API call to get all the tab values and information from a given, completed envelope in addition to draft ones. Tab values can be retrieved by using the EnvelopeRecipients:list method with query parameter include_tabs set to "true".
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Recipient Id | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.  
Include anchor tab locations | When set to **true** , all tabs with anchor tab properties are included in the response. The default value is **false**.  
Include metadata | When set to **true** , the response includes metadata indicating which properties are editable.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Tabs Blob Get Tabs Blob
`<docusign:get-v21-accounts-envelopes-tabs-blob-by-account-id-envelope-id>`
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream