List documents associated with template

GET

/v2.1/accounts/:accountId/templates/:templateId/documents

GET

/restapi/v2.1/accounts/:accountId/templates/:templateId/documents

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

{
  "templateDocuments": [
    {
      "addedRecipientIds": [
        "sample string 1"
      ],
      "agreementType": "sample string 1",
      "agreementTypeSource": "sample string 2",
      "attachmentTabId": "sample string 3",
      "authoritativeCopy": "sample string 4",
      "authoritativeCopyMetadata": {
        "options": [
          "sample string 1"
        ],
        "rights": "sample string 1"
      },
      "availableDocumentTypes": [
        {
          "isDefault": "sample string 1",
          "type": "sample string 2"
        }
      ],
      "containsPdfFormFields": "sample string 5",
      "display": "sample string 6",
      "docGenDocumentStatus": "sample string 7",
      "docGenErrors": [
        {
          "errorCode": "sample string 1",
          "message": "sample string 2",
          "tagIdentifier": "sample string 3"
        }
      ],
      "docGenFormFields": [
        {
          "children": [
            {}
          ],
          "connectedObjectDetails": {
            "recordId": "sample string 1"
          },
          "defaultValue": "sample string 1",
          "description": "sample string 2",
          "format": {
            "expression": "sample string 1",
            "locale": "sample string 2"
          },
          "fullyQualifiedPath": "sample string 3",
          "hidden": true,
          "label": "sample string 4",
          "name": "sample string 5",
          "options": [
            {
              "description": "sample string 1",
              "label": "sample string 2",
              "selected": "sample string 3",
              "value": "sample string 4"
            }
          ],
          "order": "sample string 6",
          "predefinedValidation": "sample string 7",
          "readOnly": true,
          "required": "sample string 8",
          "rowValues": [
            {
              "docGenFormFieldList": [
                {}
              ]
            }
          ],
          "type": "sample string 9",
          "validation": {
            "errorMessage": "sample string 1",
            "expression": "sample string 2"
          },
          "value": "sample string 10"
        }
      ],
      "documentBase64": "sample string 8",
      "documentFields": [
        {
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          },
          "name": "sample string 1",
          "originalValue": "sample string 2",
          "value": "sample string 3"
        }
      ],
      "documentId": "sample string 9",
      "documentIdGuid": "sample string 10",
      "documentTemplateId": "sample string 11",
      "hasDigitalSignature": "sample string 12",
      "includeInDownload": "sample string 13",
      "isAceGenDocument": "sample string 14",
      "isDocGenDocument": "sample string 15",
      "isEdited": "sample string 16",
      "isExternallyAvailable": "sample string 17",
      "isFlattened": "sample string 18",
      "name": "sample string 19",
      "order": "sample string 20",
      "pages": [
        {
          "dpi": "sample string 1",
          "height": "sample string 2",
          "imageBytes": "sample string 3",
          "mimeType": "sample string 4",
          "pageId": "sample string 5",
          "sequence": "sample string 6",
          "width": "sample string 7"
        }
      ],
      "signerMustAcknowledge": "sample string 21",
      "sizeBytes": "sample string 22",
      "templateLocked": "sample string 23",
      "templateRequired": "sample string 24",
      "type": "sample string 25",
      "uri": "sample string 26"
    }
  ],
  "templateId": "sample string 1"
}

Retrieves a list of documents associated with the specified template.

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.

templateIdstringRequired

The ID of the template.

Query parameters

include_agreement_typestringOptional

include_is_editedstringOptional

include_tabsstringOptional

Reserved for Docusign.

Response

Successful response.

templateDocumentslist of objectsOptional

An array of document objects that contain information about the documents associated with the template.

templateIdstringOptional

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

Errors

400

Bad Request Error