DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Account → Get Envelope Purge Configuration

AI-generated

Summary

Retrieve envelope purge configuration for a DocuSign account using specified authentication and category settings.

Inputs

  • authentication — Authentication method to use for the DocuSign API request. Defaults to OAuth2 if not specified. Choose between OAuth2 or JWT (Service Integration).
  • category — The API category to work with. Defaults to 'envelopes'. Select the relevant DocuSign resource category (e.g., Envelopes, Templates, Account, etc.).
  • accountId (required) — The DocuSign Account ID (GUID). Required. Find it in DocuSign Admin → API and Keys.

Output shape

The DocuSign API returns the envelope purge configuration details for the specified account and category. Exact return shape depends on the category selected and DocuSign's current API response format.

Authentication and accountId are required for the API call. The category parameter scopes which part of the account's configuration is retrieved. If omitted, 'envelopes' is the default category.

Examples

Example 1: Retrieve purge configuration using OAuth2 for the envelopes category.

authentication: oAuth2, category: envelopes, accountId: ''

Links

Discussion