Skip to navigation
How-to guidesUse envelopes and templates

How to list envelope recipients

View as Markdown

This topic demonstrates how to retrieve a list of all envelope recipients and their associated status details, such as the signing status for each envelope document.

Run this code example from our Quickstart or launcher projects: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby.

Required data

Running the code in this how-to requires this data:

Data elementDescription
{API_ACCOUNT_ID}A GUID 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 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://<domain>/restapi
Where <domain> is demo.docusign.net for the developer environment and is the result of the GetUserInfo call in production.
{ENVELOPE_ID}A GUID value that identifies a Docusign envelope. 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.

See 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

Step 2. List envelope recipients

List the recipient data for a given envelope using the following steps:

  • Instantiate the Docusign API client.
  • Set the following default request header to add your access token. "Authorization" : "Bearer {ACCESS TOKEN}"
  • Initialize the Envelopes API.
  • Call the EnvelopeRecipients:list method with the ID of the envelope whose recipients you want to list. Depending on the complexity of your document, the amount of data returned could be vast and include attributes such as agents, editors, inPersonSigners, intermediaries, and more.

Note: The currentRoutingOrder parameter specifies which current step in the signing order is active. Completed documents will reveal the Signer information including signed name and initials. Keep in mind that confidential data such as a Social Security number is not returned through the API and must be returned via the form data link on the Developer Console.

Note: When tracking your users, a client user ID can be specified on your side for ease of granularity. Recipient GUIDs are generated on a per-envelope basis, which should help when troubleshooting potential issues within your workflow,

View the source code for this how-to on GitHub: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
     --header "Content-Type: application/json" \
     --request GET ${base_path}/v2.1/accounts/${account_id}/envelopes/${envelope_id}/recipients

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
{
  "signers":
  [
    {
      "creationReason": "sender",
      "isBulkRecipient": "false",
      "requireUploadSignature": "false",
      "name": "Test One",
      "firstName": "",
      "lastName": "",
      "email": "test1@anyemail.com",
      "recipientId": "1",
      "recipientIdGuid": "7805c51d-xxxx-xxxx-xxxx-3da130b68252",
      "requireIdLookup": "false",
      "userId": "728df083-xxxx-xxxx-xxxx-ee46a1a65f43",
      "routingOrder": "1",
      "status": "completed",
      "completedCount": "1",
      "signedDateTime": "2020-08-13T22:03:04.4130000Z",
      "deliveredDateTime": "2020-08-13T22:02:52.1970000Z",
      "deliveryMethod": "email",
      "recipientType": "signer"
    }
  ],
  "agents": [],
  "editors": [],
  "intermediaries": [],
  "carbonCopies":
  [
    {
      "name": "Test Two",
      "firstName": "",
      "lastName": "",
      "email": "test2@anyemail.com",
      "recipientId": "2",
      "recipientIdGuid": "b743faf9-xxxx-xxxx-xxxx-0720dfe8118f",
      "requireIdLookup": "false",
      "userId": "0724cab8-xxxx-xxxx-xxxx-82e55f5b02fa",
      "routingOrder": "2",
      "status": "completed",
      "completedCount": "0",
      "deliveryMethod": "email",
      "recipientType": "carboncopy"
    }
  ],
  "certifiedDeliveries": [],
  "inPersonSigners": [],
  "seals": [],
  "witnesses": [],
  "recipientCount": "2",
  "currentRoutingOrder": "1"
}

Next steps