Get template document HTML definitions

GET

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

GET

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

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

{
  "htmlDefinitions": [
    {
      "documentId": "sample string 1",
      "documentIdGuid": "sample string 2",
      "htmlDefinition": {
        "displayAnchorPrefix": "sample string 1",
        "displayAnchors": [
          {
            "caseSensitive": true,
            "endAnchor": "sample string 1",
            "removeEndAnchor": true,
            "removeStartAnchor": true,
            "startAnchor": "sample string 2"
          }
        ],
        "displayOrder": "sample string 2",
        "displayPageNumber": "sample string 3",
        "documentGuid": "sample string 4",
        "documentId": "sample string 5",
        "headerLabel": "sample string 6",
        "maxScreenWidth": "sample string 7",
        "removeEmptyTags": "sample string 8",
        "showMobileOptimizedToggle": "sample string 9",
        "source": "sample string 10"
      }
    }
  ]
}

Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a 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.

documentIdstringRequired

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).

Tab objects have a documentId property that specifies the document on which to place the tab.

templateIdstringRequired

The ID of the template.

Response

Successful response.

htmlDefinitionslist of objectsOptional

Holds the properties that define how to generate the responsive-formatted HTML for the document.

Errors

400

Bad Request Error