> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # How to get envelope information > Demonstrates how to get data on an already-defined envelope. This topic demonstrates how to get the full set of data associated with an envelope that was sent by your app. Using the code presented here, you can see whether documents have been signed and which, if any, outstanding items remain to be completed. This example will return information about the envelope, particularly its status (`any`, `created`, `deleted`, `sent`, `delivered`, `signed`, `completed`, `declined`, `timedout`, `voided`), the time and date of the most recent action on the envelope, and any additional metadata associated with that envelope. > **Note** > > Run this code example from our [Quickstart](/docs/esign-rest-api/quickstart) or launcher projects: [Bash](https://github.com/docusign/code-examples-bash), [C#](https://github.com/docusign/code-examples-csharp), [Java](https://github.com/docusign/code-examples-java), [Node.js](https://github.com/docusign/code-examples-node), [PHP](https://github.com/docusign/code-examples-php), [PowerShell](https://github.com/docusign/code-examples-powershell), [Python](https://github.com/docusign/code-examples-python), or [Ruby](https://github.com/docusign/code-examples-ruby). ## Required data Running the code in this how-to requires this data: | Data element | Description | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \{API_ACCOUNT_ID} | A [GUID](http://guid.one/) value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the **API Account ID** field on the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=appsAndKeys) page. | | \{BASE_PATH} | A string value that forms the root of the URL required to make API calls. The base path value in the example code is set to target the developer environment at https\://\/restapi Where \ is demo.docusign.net for the developer environment and is the result of the GetUserInfo call in production. | | \{ENVELOPE_ID} | A [GUID](http://guid.one/) value that identifies a Docusign [envelope](/docs/esign-rest-api/esign101/concepts/envelopes). This value is automatically generated by Docusign when the envelope is created. | ## Step 1. Obtain your OAuth token To make the API call shown in this how-to, you need a valid OAuth access token. Docusign supports access tokens for three different recommended OAuth grant types: Public Authorization Code Grant, Confidential Authorization Code Grant, and JSON Web Token (JWT) Grant. Choose the OAuth grant type appropriate for your scenario. > **Note** > > See [Confidential Authorization Code Grant](/platform/auth/authcode#confidential-authorization-code-grant) for guidance on your options to get an Confidential Authorization Code Grant OAuth token. ![Three icons that represent the three methods a user can use to obtain an OAuth token: JSON Web Token (JWT), Public Authorization Code Grant (ACG), and Confidential Authorization Code grant](/_fern-files/_img/64f473773042ee439449a096bf7673292b1585b86a4ccc55f82ba0dda41f61a1.webp) ## Step 2. Get envelope data Get the envelope data using the following steps: 1. Instantiate the Docusign API client. 2. Set the following default request header to add your access token. `"Authorization" : "Bearer {ACCESS TOKEN}"` 3. Initialize the Envelopes API. 4. Call the `GetEnvelope` method with the ID of the envelope you want to retrieve. The returned data will include the envelope status, the dates when the status was changed, and all other metadata associated with the envelope. Depending on the complexity of your envelope, the amount of data returned could be vast and include attributes such as `agents`, `editors`, `inPersonSigners`, `intermediaries`, and more. > **Note** > > View the source code for this how-to on GitHub: [Bash](https://github.com/docusign/code-examples-bash/blob/master/examples/eSignature/eg004EnvelopeInfo.sh), [C#](https://github.com/docusign/code-examples-csharp/blob/master/launcher-csharp/eSignature/Examples/GetEnvelopeInformation.cs), [Java](https://github.com/docusign/code-examples-java/blob/master/src/main/java/com/docusign/controller/eSignature/services/EnvelopeInfoService.java), [Node.js](https://github.com/docusign/code-examples-node/blob/master/lib/eSignature/examples/envelopeInfo.js), [PHP](https://github.com/docusign/code-examples-php/blob/master/src/Services/Examples/eSignature/EnvelopeInfoService.php), [PowerShell](https://github.com/docusign/code-examples-powershell/blob/master/examples/eSignature/eg004EnvelopeInfo.ps1), [Python](https://github.com/docusign/code-examples-python/blob/master/app/eSignature/examples/eg004_envelope_info.py), or [Ruby](https://github.com/docusign/code-examples-ruby/blob/main/app/services/e_sign/eg004_envelope_info_service.rb). **`Bash`** ```bash title="Bash" curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Content-Type: application/json" \ --request GET ${base_path}/v2.1/accounts/${account_id}/envelopes/${envelope_id} ``` **`C#`** ```csharp title="C#" var docuSignClient = new DocuSignClient(basePath); docuSignClient.Configuration.DefaultHeader.Add("Authorization", "Bearer " + accessToken); EnvelopesApi envelopesApi = new EnvelopesApi(docuSignClient); var getEnvelopeReponse = envelopesApi.GetEnvelopeWithHttpInfo(accountId, envelopeId); getEnvelopeReponse.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining); getEnvelopeReponse.Headers.TryGetValue("X-RateLimit-Reset", out string reset); if (reset != null && remaining != null) { DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime; Console.WriteLine("API calls remaining: " + remaining); Console.WriteLine("Next Reset: " + resetDate); } return getEnvelopeReponse.Data; ``` **`Java`** ```java title="Java" public final class EnvelopeInfoService { public static Envelope envelopeInfo( EnvelopesApi envelopesApi, String accountId, String envelopeId) throws ApiException { var envelopeResponse = envelopesApi.getEnvelopeWithHttpInfo(accountId, envelopeId, envelopesApi.new GetEnvelopeOptions()); Map> headers = envelopeResponse.getHeaders(); java.util.List remaining = headers.get("X-RateLimit-Remaining"); java.util.List reset = headers.get("X-RateLimit-Reset"); if (remaining != null & reset != null) { Instant resetInstant = Instant.ofEpochSecond(Long.parseLong(reset.get(0))); System.out.println("API calls remaining: " + remaining); System.out.println("Next Reset: " + resetInstant); } return envelopeResponse.getData(); } } ``` **`Node.js`** ```javascript title="Node.js" let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); let envelopesApi = new docusign.EnvelopesApi(dsApiClient); let results = null; // Step 1. Call Envelopes::get // Exceptions will be caught by the calling function results = await envelopesApi.getEnvelope( args.accountId, args.envelopeId, null, (error, data, response) => { const headers = response?.headers; const remaining = headers?.['x-ratelimit-remaining']; const reset = headers?.['x-ratelimit-reset']; if (remaining && reset) { const resetInstant = new Date(Number(reset) * 1000); console.log(`API calls remaining: ${remaining}`); console.log(`Next Reset: ${resetInstant.toISOString()}`); } }); ``` **`PHP`** ```php title="PHP" public static function envelopeInfo(array $args, $clientService): Envelope { # Call API method # Exceptions will be caught by the calling function $envelope_api = $clientService->getEnvelopeApi(); try { $envelopeId = $envelope_api->getEnvelopeWithHttpInfo($args['account_id'], $args['envelope_id']); $remaining = $envelopeId[2]['X-RateLimit-Remaining'] ?? null; $reset = $envelopeId[2]['X-RateLimit-Reset'] ?? null; if ($remaining !== null && $reset !== null) { $resetInstant = (new DateTime())->setTimestamp((int)$reset); error_log("API calls remaining: $remaining"); error_log("Next Reset: " . $resetInstant->format(\DateTime::ATOM)); } } catch (ApiException $e) { $clientService->showErrorTemplate($e); exit; } return $envelopeId[0]; } ``` **`PowerShell`** ```text title="PowerShell" Invoke-RestMethod ` -Uri "${apiUri}/v2.1/accounts/${accountId}/envelopes/${envelopeId}" ` -Method 'GET' ` -Headers @{ 'Authorization' = "Bearer $accessToken"; 'Content-Type' = "application/json"; } ``` **`Python`** ```python title="Python" api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"]) envelope_api = EnvelopesApi(api_client) # Call the envelope get method (data, status, headers) = envelope_api.get_envelope_with_http_info(account_id=args["account_id"], envelope_id=args["envelope_id"]) remaining = headers.get("X-RateLimit-Remaining") reset = headers.get("X-RateLimit-Reset") if remaining is not None and reset is not None: reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc) print(f"API calls remaining: {remaining}") print(f"Next Reset: {reset_date}") ``` **`Ruby`** ```ruby title="Ruby" envelope_api = create_envelope_api(args) results, _status, headers = envelope_api.get_envelope_with_http_info(args[:account_id], args[:envelope_id]) remaining = headers['X-RateLimit-Remaining'] reset = headers['X-RateLimit-Reset'] if remaining && reset reset_date = Time.at(reset.to_i).utc puts "API calls remaining: #{remaining}" puts "Next Reset: #{reset_date}" end ``` ## Expected response If you run this code example from our Quickstart or launcher projects, you should see a JSON response similar to the code shown. **`Sample response`** ```json title="Sample response" { "status": "completed", "documentsUri": "/envelopes/bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87/documents", "recipientsUri": "/envelopes/bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87/recipients", "attachmentsUri": "/envelopes/bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87/attachments", "envelopeUri": "/envelopes/bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87", "emailSubject": "Please sign this document set", "envelopeId": "bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87", "signingLocation": "online", "customFieldsUri": "/envelopes/bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87/custom_fields", "notificationUri": "/envelopes/bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87/notification", "enableWetSign": "true", "allowMarkup": "false", "allowReassign": "true", "createdDateTime": "2020-08-13T22:01:19.9600000Z", "lastModifiedDateTime": "2020-08-13T22:01:19.9600000Z", "deliveredDateTime": "2020-08-13T22:03:05.8370000Z", "initialSentDateTime": "2020-08-13T22:01:21.1300000Z", "sentDateTime": "2020-08-13T22:03:05.8370000Z", "completedDateTime": "2020-08-13T22:03:05.8370000Z", "statusChangedDateTime": "2020-08-13T22:03:05.8370000Z", "documentsCombinedUri": "/envelopes/bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87/documents/combined", "certificateUri": "/envelopes/bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87/documents/certificate", "templatesUri": "/envelopes/bc4799a2-xxxx-xxxx-xxxx-20d1921aeb87/templates", "expireEnabled": "true", "expireDateTime": "2020-12-11T22:01:21.1300000Z", "expireAfter": "114", "sender": { "userName": "Admin One", "userId": "c1c4ca80-xxxx-xxxx-xxxx-32a3a9b13925", "accountId": "a56df5fc-xxxx-xxxx-xxxx-f64dc8ab421e", "email": "admin1@anyemail.com" }, "purgeState": "unpurged", "envelopeIdStamping": "true", "is21CFRPart11": "false", "signerCanSignOnMobile": "true", "autoNavigation": "true", "isSignatureProviderEnvelope": "false", "hasFormDataChanged": "false", "allowComments": "true", "hasComments": "false", "allowViewHistory": "true", "envelopeMetadata": { "allowAdvancedCorrect": "true", "enableSignWithNotary": "true", "allowCorrect": "true" }, "anySigner": null, "envelopeLocation": "current_site", "isDynamicEnvelope": "false" } ``` ## Next steps * Run this code example from our [Quickstart](/docs/esign-rest-api/quickstart) or launcher projects: [Bash](https://github.com/docusign/code-examples-bash), [C#](https://github.com/docusign/code-examples-csharp), [Java](https://github.com/docusign/code-examples-java), [Node.js](https://github.com/docusign/code-examples-node), [PHP](https://github.com/docusign/code-examples-php), [PowerShell](https://github.com/docusign/code-examples-powershell), [Python](https://github.com/docusign/code-examples-python), or [Ruby](https://github.com/docusign/code-examples-ruby). * Learn about [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search). * See [Envelopes:listStatus](/docs/esign-rest-api/reference/envelopes/envelopes/liststatus) for the full list of envelope status values. * See how to [Go-Live](/docs/esign-rest-api/go-live) with a completed app and find the base path for API calls in the production environment.