Get bulk send list

GET

/v2.1/accounts/:accountId/bulk_send_lists/:bulkSendListId

GET

/restapi/v2.1/accounts/:accountId/bulk_send_lists/:bulkSendListId

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/bulk_send_lists/BULK_SEND_LIST_ID \
     -H "Authorization: Bearer <apiKey>"

{
  "bulkCopies": [
    {
      "customFields": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "docGenFormFields": [
        {
          "name": "sample string 1",
          "rowValues": [
            {
              "docGenFormFieldList": [
                {}
              ]
            }
          ],
          "value": "sample string 2"
        }
      ],
      "emailBlurb": "sample string 1",
      "emailSubject": "sample string 2",
      "prefillTabs": [
        {
          "initialValue": "sample string 1",
          "tabLabel": "sample string 2"
        }
      ],
      "recipients": [
        {
          "accessCode": "sample string 1",
          "clientUserId": "sample string 2",
          "customFields": [
            "sample string 1"
          ],
          "deliveryMethod": "sample string 3",
          "email": "sample string 4",
          "emailNotification": {
            "emailBody": "sample string 1",
            "emailSubject": "sample string 2",
            "supportedLanguage": "sample string 3"
          },
          "embeddedRecipientStartURL": "sample string 5",
          "faxNumber": "sample string 6",
          "hostEmail": "sample string 7",
          "hostName": "sample string 8",
          "idCheckConfigurationName": "sample string 9",
          "identificationMethod": "sample string 10",
          "identityVerification": {
            "hasAutoAttachedRiskAssessment": "sample string 1",
            "inputOptions": [
              {}
            ],
            "workflowId": "sample string 2",
            "workflowLabel": "sample string 3"
          },
          "name": "sample string 11",
          "note": "sample string 12",
          "phoneAuthentication": {
            "recipMayProvideNumber": "sample string 1",
            "recordVoicePrint": "sample string 2",
            "senderProvidedNumbers": [
              "sample string 1"
            ],
            "validateRecipProvidedNumber": "sample string 3"
          },
          "recipientId": "sample string 13",
          "recipientSignatureProviders": [
            {
              "sealDocumentsWithTabsOnly": "sample string 1",
              "sealName": "sample string 2",
              "signatureProviderName": "sample string 3"
            }
          ],
          "roleName": "sample string 14",
          "signerName": "sample string 15",
          "signingGroupId": "sample string 16",
          "smsAuthentication": {
            "senderProvidedNumbers": [
              "sample string 1"
            ]
          },
          "socialAuthentications": [
            {
              "authentication": "sample string 1"
            }
          ],
          "tabs": [
            {
              "initialValue": "sample string 1",
              "tabLabel": "sample string 2"
            }
          ]
        }
      ]
    }
  ],
  "listId": "sample string 1",
  "name": "sample string 2"
}

This method returns all of the details associated with a specific bulk send list that belongs to the current user.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID Guid.

bulkSendListIdstringRequired

The GUID of the bulk send list. This property is created after you post a new bulk send list.

Response

Successful response.

bulkCopieslist of objectsOptional

An array of bulkCopy objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information.

listIdstringOptional

The GUID of the bulk send list.

namestringOptional

The name of the bulk send list.

Errors

400

Bad Request Error