Dropbox Sign Developer Documentation

curl -X GET 'https://api.hellosign.com/v3/template/list?page=1&page_size=20' \
  -u 'YOUR_API_KEY:'

{
  "templates": [
    {
      "template_id": "c26b8a16784a872da37ea946b9ddec7c1e11dff6",
      "title": "Purchase order",
      "message": "",
      "updated_at": 1570471067,
      "is_embedded": false,
      "is_creator": false,
      "can_edit": true,
      "is_locked": false,
      "metadata": {},
      "signer_roles": [
        {
          "name": "Client"
        }
      ],
      "cc_roles": [
        {
          "name": "Accounting"
        }
      ],
      "documents": [
        {
          "name": "purchase_order.pdf",
          "index": 0,
          "field_groups": [],
          "form_fields": [],
          "custom_fields": [
            {
              "type": "text",
              "api_id": "b0e195cf-fb85-4dd4-94ab-6f62450c7059",
              "group": null,
              "height": 14,
              "name": "Cost",
              "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
          }
        }
      ]
    },
    {
      "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",
              "height": 15,
              "name": "DepartmentA",
              "required": false,
              "signer": "1",
              "width": 15,
              "x": 117,
              "y": 19
            },
            {
              "type": "checkbox",
              "api_id": "b65e03_11",
              "height": 15,
              "name": "DepartmentB",
              "required": false,
              "signer": "2",
              "width": 15,
              "x": 118,
              "y": 41
            },
            {
              "type": "text",
              "api_id": "0ec7a7_1",
              "height": 30,
              "name": "VendorName",
              "required": true,
              "signer": "1",
              "width": 80,
              "x": 160,
              "y": 141
            },
            {
              "type": "text",
              "api_id": "0ec7a7_2",
              "height": 30,
              "name": "VendorTitle",
              "required": true,
              "signer": "2",
              "width": 80,
              "x": 160,
              "y": 181
            },
            {
              "type": "text",
              "api_id": "0ec7a7_3",
              "height": 30,
              "name": "ManagerName",
              "required": true,
              "signer": "2",
              "width": 80,
              "x": 160,
              "y": 221
            },
            {
              "type": "text",
              "api_id": "0ec7a7_4",
              "height": 30,
              "name": "ManagerTitle",
              "required": true,
              "signer": "2",
              "width": 80,
              "x": 160,
              "y": 251
            },
            {
              "type": "date_signed",
              "api_id": "0ec7a7_5",
              "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",
              "group": null,
              "height": 14,
              "name": "Effective Date",
              "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
          }
        }
      ]
    }
  ],
  "list_info": {
    "num_pages": 1,
    "num_results": 2,
    "page": 1,
    "page_size": 20
  }
}

Returns a list of the Templates that are accessible by you.

Take a look at our search guide to learn more about querying templates.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

account_idstringOptional

Which account to return Templates for. Must be a team member. Use all to indicate all team members. Defaults to your account.

pageintegerOptionalDefaults to 1

Which page number of the Template List to return. Defaults to 1.

page_sizeintegerOptional1-100Defaults to 20

Number of objects to be returned per page. Must be between 1 and 100. Default is 20.

querystringOptional

String that includes search terms and/or fields to be used to filter the Template objects.

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

templateslist of objects

List of templates that the API caller has access to.

list_infoobject

Contains pagination information about the data returned.

warningslist of objects or null

A list of warnings.

List Templates

Authentication

Query parameters

Response headers

Response

Errors