Dropbox Sign Developer Documentation

curl -X GET 'https://api.hellosign.com/v3/template/{template_id}' \
  -u 'YOUR_API_KEY:'

{
  "template": {
    "template_id": "f57db65d3f933b5316d398057a36176831451a35",
    "title": "Mutual NDA",
    "message": "Please sign this NDA as soon as possible.",
    "updated_at": 1570471067,
    "is_embedded": false,
    "is_creator": true,
    "can_edit": true,
    "is_locked": false,
    "metadata": {},
    "signer_roles": [
      {
        "name": "Outside Vendor",
        "order": 0
      },
      {
        "name": "Internal Manager",
        "order": 1
      }
    ],
    "cc_roles": [
      {
        "name": "Corporate Attorney"
      }
    ],
    "documents": [
      {
        "name": "mutual_nda.pdf",
        "index": 0,
        "field_groups": [
          {
            "name": "group1",
            "rule": {}
          }
        ],
        "form_fields": [
          {
            "type": "checkbox",
            "api_id": "b65e03_10",
            "group": "group1",
            "height": 15,
            "name": "DepartmentA",
            "required": false,
            "signer": "1",
            "width": 15,
            "x": 117,
            "y": 19
          },
          {
            "type": "checkbox",
            "api_id": "b65e03_11",
            "group": "group1",
            "height": 15,
            "name": "DepartmentB",
            "required": false,
            "signer": "2",
            "width": 15,
            "x": 118,
            "y": 41
          },
          {
            "type": "text",
            "api_id": "0ec7a7_1",
            "avg_text_length": {
              "num_lines": 1,
              "num_chars_per_line": 19
            },
            "fontFamily": "arial",
            "group": null,
            "height": 30,
            "isMultiline": false,
            "name": "VendorName",
            "originalFontSize": 12,
            "required": true,
            "signer": "1",
            "width": 80,
            "x": 160,
            "y": 141
          },
          {
            "type": "text",
            "api_id": "0ec7a7_2",
            "avg_text_length": {
              "num_lines": 1,
              "num_chars_per_line": 19
            },
            "fontFamily": "arial",
            "group": null,
            "height": 30,
            "isMultiline": false,
            "name": "VendorTitle",
            "originalFontSize": 12,
            "required": true,
            "signer": "2",
            "width": 80,
            "x": 160,
            "y": 181
          },
          {
            "type": "text",
            "api_id": "0ec7a7_3",
            "avg_text_length": {
              "num_lines": 1,
              "num_chars_per_line": 19
            },
            "fontFamily": "arial",
            "group": null,
            "height": 30,
            "isMultiline": false,
            "name": "ManagerName",
            "originalFontSize": 12,
            "required": true,
            "signer": "2",
            "width": 80,
            "x": 160,
            "y": 221
          },
          {
            "type": "text",
            "api_id": "0ec7a7_4",
            "avg_text_length": {
              "num_lines": 1,
              "num_chars_per_line": 19
            },
            "fontFamily": "arial",
            "group": null,
            "height": 30,
            "isMultiline": false,
            "name": "ManagerTitle",
            "originalFontSize": 12,
            "required": true,
            "signer": "2",
            "width": 80,
            "x": 160,
            "y": 251
          },
          {
            "type": "date_signed",
            "api_id": "0ec7a7_5",
            "group": null,
            "height": 16,
            "name": "DateSigned",
            "required": true,
            "signer": "1",
            "width": 105,
            "x": 523,
            "y": 28
          }
        ],
        "custom_fields": [
          {
            "type": "text",
            "api_id": "78083014-32d8-4b5b-b65e-fe6010f3be64",
            "avg_text_length": {
              "num_lines": 1,
              "num_chars_per_line": 22
            },
            "fontFamily": "arial",
            "group": null,
            "height": 14,
            "isMultiline": false,
            "name": "Effective Date",
            "originalFontSize": 12,
            "required": false,
            "signer": null,
            "width": 84,
            "x": 378,
            "y": 36
          }
        ]
      }
    ],
    "accounts": [
      {
        "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
        "email_address": "me@dropboxsign.com",
        "is_locked": false,
        "is_paid_hs": true,
        "is_paid_hf": false,
        "quotas": {
          "api_signature_requests_left": 0,
          "documents_left": 3600000,
          "sms_verifications_left": 300000
        }
      }
    ]
  }
}

Returns the Template specified by the template_id parameter.

Authentication

AuthorizationBasic

Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information. ✅ Supported by Try it console (calls sent in test_mode only).

AuthorizationBearer

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See Authentication for more information. ❌ Not supported by Try it console.

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information. ❌ **Not supported** by Try it console.

Path parameters

template_idstringRequired

The id of the Template to retrieve.

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

templateobject

Contains information about the templates you and your team have created.

warningslist of objects

A list of warnings.

Errors

4XX

Client Request Error