DocuSign

Get a List of Billing Invoices

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

Get a list of past due invoices.

Returns a list past due invoices for the account and notes if payment can be made through the REST API. Privileges Required: account administrator

Get Connect configuration information.

Retrieves all the Docusign Custom Connect definitions for the specified account. <ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage>

Get credit card information

This method returns information about a credit card associated with an account.

Get the Cloud Storage Provider configuration for the specified user.

Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

Gets a BCC email archive configuration and its history.

This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.

Gets a brand logo.

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**).

Gets a Connect log entry.

Retrieves the specified Connect log entry for your account. <ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage> 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.

Gets a jurisdiction object for the current user. The user must be a notary.

Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for.

Gets a list of available billing plans.

Retrieves a list of the billing plans associated with a distributor.

Gets a list of brands.

This method returns details about all of the [brands](/docs/esign-rest-api/esign101/concepts/branding/) associated with an account, including the default brand profiles. Either or both of the following settings must be enabled for the account to use this method: - `canSelfBrandSign` - `canSelfBrandSend` ### Related topics - [How to create a brand](/docs/esign-rest-api/how-to/create-brand/) - [How to apply a brand to an envelope](/docs/esign-rest-api/how-to/apply-brand-to-envelope/)

Gets a list of custom fields.

This method returns a list of the envelope and document custom fields associated with an account.

Gets a list of documents associated with a template.

Retrieves a list of documents associated with the specified template.

Gets a list of permission profiles.

This method returns a list of permission profiles that are associated with an account. Example: ```json { "permissionProfiles": [ { "permissionProfileId": "1665536", "permissionProfileName": "Account Administrator", "modifiedDateTime": "2018-03-26T03:54:40.4470000Z", "modifiedByUsername": "" }, { "permissionProfileId": "1665537", "permissionProfileName": "DocuSign Sender", "modifiedDateTime": "2018-03-26T03:54:40.4470000Z", "modifiedByUsername": "" }, { "permissionProfileId": "1665538", "permissionProfileName": "DocuSign Viewer", "modifiedDateTime": "2016-06-02T01:53:15.6830000Z", "modifiedByUsername": "" }, { "permissionProfileId": "10325926", "permissionProfileName": "DS Manage Company Member Accounts", "modifiedDateTime": "2020-05-15T00:28:36.8230000Z", "modifiedByUsername": "Nat Irving" } ] } ```

Gets a list of users in a group.

Retrieves a list of users in a group.

Gets a PDF transcript of all of the comments in an envelope.

Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. **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**).

Gets a request logging log file.

Retrieves information for a single log entry. **Request** The `requestLogId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned. **Response** If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.

Gets billing payment information for a specific payment.

Retrieves the information for a specified payment. Privileges required: account administrator

Gets billing plan details.

Retrieves the billing plan details for the specified billing plan ID.

Gets envelope lock information.

Retrieves general information about an envelope lock. The user requesting the information must be the same user who locked the envelope. You can use this method to recover the lock information, including the `lockToken`, for a locked envelope. The `X-DocuSign-Edit` header is included in the response. See [EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) for a description of the `X-DocuSign-Edit` header. ### Related topics - [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)

Gets envelope notification defaults.

This method returns the default settings for the email notifications that signers and senders receive about envelopes.

Gets envelope notification information.

Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

Gets envelope transfer rules.

This method retrieves a list of envelope transfer rules associated with an account. **Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Gets information about a brand.

This method returns details about an account [brand](/docs/esign-rest-api/esign101/concepts/branding/). **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).

Gets list of recurring and usage charges for the account.

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

Gets membership account password rules.

Gets notary jurisdictions for a user.

Gets one or more contacts.

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]: /docs/esign-rest-api/reference/cloudstorage/

Gets payment information for one or more payments.

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

Gets PowerForm senders.

This method returns a list of users who have sent PowerForms.

Gets settings for a notary user.

Gets settings for a notary user. The current user must be a notary.

Gets template lock information.

Retrieves general information about a template lock. The user requesting the information must be the same user who locked the template. You can use this method to recover the lock information, including the `lockToken`, for a locked template. The `X-DocuSign-Edit` header is included in the response. See [TemplateLocks: create](/docs/esign-rest-api/reference/templates/templatelocks/create/) for a description of the `X-DocuSign-Edit` header. ### Related topics - [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)

Gets template notification information.

Retrieves the envelope notification, reminders and expirations, information for an existing template.

Gets the API request logging log files.

Retrieves a list of log entries as a JSON or XML object or as a zip file containing the entries. If the Accept header is set to `application/zip`, the response is a zip file containing individual text files, each representing an API request. If the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below.

Gets the API request logging settings.

Retrieves the current API request logging setting for the user and remaining log entries. **Response** The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.

Gets the available signature providers for an account.

Returns a list of signature providers that the specified account can use.

Gets the BCC email archive configurations for an account.

This method retrieves all of the BCC email archive configurations associated with an account.

Gets the brand information for a group.

This method returns information about the brands associated with a group.

Gets the Connect failure log information.

Retrieves the Connect failure log information. <ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage> Use this method to determine which envelopes failed to post. You can then use [ConnectEvents: retryForEnvelopes][retry] to create a republish request. [retry]: /docs/esign-rest-api/reference/connect/connectevents/retryforenvelopes/

Gets the Connect log.

Retrieves a list of the 100 most recent Connect log entries for your account. <ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage> The `enableLog` setting in the Connect configuration must be set to **true** to enable logging. Log entries are deleted after 15 days.

Gets the custom document fields for a an existing template document.

This method retrieves the custom document fields for an existing template document.

Gets the custom document fields from a template.

Retrieves the custom document field information from an existing template.

Gets the custom document fields from an existing envelope document.

Retrieves the custom document field information from an existing envelope document.

Gets the custom field information for the specified envelope.

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 pre-made list. ### Related topics - [How to get envelope custom tab values](/docs/esign-rest-api/how-to/get-envelope-custom-tab-values/)

Gets the default Electronic Record and Signature Disclosure for an account.

Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. This is 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.

Gets the default Electronic Record and Signature Disclosure for an envelope.

Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify. This is 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.

Gets the details about a Connect configuration.

Retrieves the information for the specified Docusign Connect configuration. <ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage>

Gets the Electronic Record and Signature Disclosure for an account.

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.

Gets the email setting overrides for an envelope.

Retrieves the email override settings for the specified envelope.

Gets the envelope audit events for an envelope.

Gets the envelope audit events for the specified envelope.

Gets the envelope purge configuration for an account.

An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account. **Note:** To use this method, you must be an account administrator.

Gets the password rules for an account.

This method retrieves the password rules for an account.

Gets the specified Cloud Storage Provider configuration for the User.

Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

List payment gateway accounts

This method returns a list of payment gateway accounts and basic information about them.

Retrieves a billing invoice.

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. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | Docusign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |

Retrieves an envelope attachment from an envelope.

Retrieves an envelope attachment from an envelope. <!-- std notice DEVDOCS-114911 --> <ds-inlinemessage kind="information" markdown="1"> It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments. To learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide. </ds-inlinemessage> <!-- end notice DEVDOCS-114911 -->

Retrieves the account information for the specified account.

Retrieves the account information for the specified account.

Retrieves the account provisioning information for the account.

Retrieves the account provisioning information for the account.

Retrieves the Identity Verification workflows available to an account.

This method returns a list of Identity Verification workflows that are available to an account. **Note:** To use this method, you must either be an account administrator or a sender. ### Related topics - [How to require ID Verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)

Retrieves the list of favorite templates for the account.

Retrieves the list of favorite templates for the account.