Get template document HTML definitions

GET

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

GET

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

curl https://demo.docusign.net/restapi/v2/accounts/accountId/templates/templateId/documents/documentId/html_definitions \
     -H "Authorization: <apiKey>"

{
  "htmlDefinitions": [
    {
      "documentId": "string",
      "documentIdGuid": "string",
      "htmlDefinition": {
        "displayAnchorPrefix": "string",
        "displayAnchors": [
          {
            "caseSensitive": true,
            "displaySettings": {
              "cellStyle": "string",
              "collapsibleSettings": {
                "arrowClosed": "string",
                "arrowColor": "string",
                "arrowLocation": "string",
                "arrowOpen": "string",
                "arrowSize": "string",
                "arrowStyle": "string",
                "containerStyle": "string",
                "labelStyle": "string",
                "onlyArrowIsClickable": true,
                "outerLabelAndArrowStyle": "string"
              },
              "display": "string",
              "displayLabel": "string",
              "displayOrder": 1,
              "displayPageNumber": 1,
              "hideLabelWhenOpened": true,
              "inlineOuterStyle": "string",
              "labelWhenOpened": "string",
              "preLabel": "string",
              "scrollToTopWhenOpened": true,
              "tableStyle": "string"
            },
            "endAnchor": "string",
            "removeEndAnchor": true,
            "removeStartAnchor": true,
            "startAnchor": "string"
          }
        ],
        "displayOrder": "string",
        "displayPageNumber": "string",
        "documentGuid": "string",
        "documentId": "string",
        "headerLabel": "string",
        "maxScreenWidth": "string",
        "removeEmptyTags": "string",
        "showMobileOptimizedToggle": "string",
        "source": "string"
      }
    }
  ]
}

Authentication

Authorizationstring

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequired

The external account number (int) or account id GUID.

documentIdstringRequired

The ID of the document being accessed.

templateIdstringRequired

The ID of the template being accessed.

Response

Successful response.

htmlDefinitionslist of objectsOptional

Errors

400

Bad Request Error