List Templates

GET

https://api.hellosign.com/v3/template/list

GET

/v3/template/list

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

1 {
2   "templates": [
3     {
4       "template_id": "c26b8a16784a872da37ea946b9ddec7c1e11dff6",
5       "title": "Purchase order",
6       "message": "",
7       "updated_at": 1570471067,
8       "is_embedded": false,
9       "is_creator": false,
10       "can_edit": true,
11       "is_locked": false,
12       "metadata": {},
13       "signer_roles": [
14         {
15           "name": "Client"
16         }
17       ],
18       "cc_roles": [
19         {
20           "name": "Accounting"
21         }
22       ],
23       "documents": [
24         {
25           "name": "purchase_order.pdf",
26           "index": 0,
27           "field_groups": [],
28           "form_fields": [],
29           "custom_fields": [
30             {
31               "type": "text",
32               "api_id": "b0e195cf-fb85-4dd4-94ab-6f62450c7059",
33               "avg_text_length": {
34                 "num_lines": 1,
35                 "num_chars_per_line": 22
36               },
37               "fontFamily": "arial",
38               "group": null,
39               "height": 14,
40               "isMultiline": false,
41               "name": "Cost",
42               "originalFontSize": 12,
43               "required": false,
44               "signer": null,
45               "width": 84,
46               "x": 378,
47               "y": 36
48             }
49           ]
50         }
51       ],
52       "accounts": [
53         {
54           "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
55           "email_address": "me@dropboxsign.com",
56           "is_locked": false,
57           "is_paid_hs": true,
58           "is_paid_hf": false,
59           "quotas": {
60             "api_signature_requests_left": 0,
61             "documents_left": 3600000,
62             "sms_verifications_left": 300000
63           }
64         }
65       ]
66     },
67     {
68       "template_id": "f57db65d3f933b5316d398057a36176831451a35",
69       "title": "Mutual NDA",
70       "message": "Please sign this NDA as soon as possible.",
71       "updated_at": 1570471067,
72       "is_embedded": false,
73       "is_creator": true,
74       "can_edit": true,
75       "is_locked": false,
76       "metadata": {},
77       "signer_roles": [
78         {
79           "name": "Outside Vendor",
80           "order": 0
81         },
82         {
83           "name": "Internal Manager",
84           "order": 1
85         }
86       ],
87       "cc_roles": [
88         {
89           "name": "Corporate Attorney"
90         }
91       ],
92       "documents": [
93         {
94           "name": "mutual_nda.pdf",
95           "index": 0,
96           "field_groups": [
97             {
98               "name": "group1",
99               "rule": {}
100             }
101           ],
102           "form_fields": [
103             {
104               "type": "checkbox",
105               "api_id": "b65e03_10",
106               "group": "group1",
107               "height": 15,
108               "name": "DepartmentA",
109               "required": false,
110               "signer": "1",
111               "width": 15,
112               "x": 117,
113               "y": 19
114             },
115             {
116               "type": "checkbox",
117               "api_id": "b65e03_11",
118               "group": "group1",
119               "height": 15,
120               "name": "DepartmentB",
121               "required": false,
122               "signer": "2",
123               "width": 15,
124               "x": 118,
125               "y": 41
126             },
127             {
128               "type": "text",
129               "api_id": "0ec7a7_1",
130               "avg_text_length": {
131                 "num_lines": 1,
132                 "num_chars_per_line": 19
133               },
134               "fontFamily": "arial",
135               "group": null,
136               "height": 30,
137               "isMultiline": false,
138               "name": "VendorName",
139               "originalFontSize": 12,
140               "required": true,
141               "signer": "1",
142               "width": 80,
143               "x": 160,
144               "y": 141
145             },
146             {
147               "type": "text",
148               "api_id": "0ec7a7_2",
149               "avg_text_length": {
150                 "num_lines": 1,
151                 "num_chars_per_line": 19
152               },
153               "fontFamily": "arial",
154               "group": null,
155               "height": 30,
156               "isMultiline": false,
157               "name": "VendorTitle",
158               "originalFontSize": 12,
159               "required": true,
160               "signer": "2",
161               "width": 80,
162               "x": 160,
163               "y": 181
164             },
165             {
166               "type": "text",
167               "api_id": "0ec7a7_3",
168               "avg_text_length": {
169                 "num_lines": 1,
170                 "num_chars_per_line": 19
171               },
172               "fontFamily": "arial",
173               "group": null,
174               "height": 30,
175               "isMultiline": false,
176               "name": "ManagerName",
177               "originalFontSize": 12,
178               "required": true,
179               "signer": "2",
180               "width": 80,
181               "x": 160,
182               "y": 221
183             },
184             {
185               "type": "text",
186               "api_id": "0ec7a7_4",
187               "avg_text_length": {
188                 "num_lines": 1,
189                 "num_chars_per_line": 19
190               },
191               "fontFamily": "arial",
192               "group": null,
193               "height": 30,
194               "isMultiline": false,
195               "name": "ManagerTitle",
196               "originalFontSize": 12,
197               "required": true,
198               "signer": "2",
199               "width": 80,
200               "x": 160,
201               "y": 251
202             },
203             {
204               "type": "date_signed",
205               "api_id": "0ec7a7_5",
206               "group": null,
207               "height": 16,
208               "name": "DateSigned",
209               "required": true,
210               "signer": "1",
211               "width": 105,
212               "x": 523,
213               "y": 28
214             }
215           ],
216           "custom_fields": [
217             {
218               "type": "text",
219               "api_id": "78083014-32d8-4b5b-b65e-fe6010f3be64",
220               "avg_text_length": {
221                 "num_lines": 1,
222                 "num_chars_per_line": 22
223               },
224               "fontFamily": "arial",
225               "group": null,
226               "height": 14,
227               "isMultiline": false,
228               "name": "Effective Date",
229               "originalFontSize": 12,
230               "required": false,
231               "signer": null,
232               "width": 84,
233               "x": 378,
234               "y": 36
235             }
236           ]
237         }
238       ],
239       "accounts": [
240         {
241           "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
242           "email_address": "me@dropboxsign.com",
243           "is_locked": false,
244           "is_paid_hs": true,
245           "is_paid_hf": false,
246           "quotas": {
247             "api_signature_requests_left": 0,
248             "documents_left": 3600000,
249             "sms_verifications_left": 300000
250           }
251         }
252       ]
253     }
254   ],
255   "list_info": {
256     "num_pages": 1,
257     "num_results": 2,
258     "page": 1,
259     "page_size": 20
260   }
261 }

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

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

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",
              "avg_text_length": {
                "num_lines": 1,
                "num_chars_per_line": 22
              },
              "fontFamily": "arial",
              "group": null,
              "height": 14,
              "isMultiline": false,
              "name": "Cost",
              "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
          }
        }
      ]
    },
    {
      "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
          }
        }
      ]
    }
  ],
  "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

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](/api/reference/authentication) for more information. ❌ **Not supported** by Try it console.

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

A list of warnings.

Errors

4XX

Client Request Error

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

1	{
2	"templates": [
3	{
4	"template_id": "c26b8a16784a872da37ea946b9ddec7c1e11dff6",
5	"title": "Purchase order",
6	"message": "",
7	"updated_at": 1570471067,
8	"is_embedded": false,
9	"is_creator": false,
10	"can_edit": true,
11	"is_locked": false,
12	"metadata": {},
13	"signer_roles": [
14	{
15	"name": "Client"
16	}
17	],
18	"cc_roles": [
19	{
20	"name": "Accounting"
21	}
22	],
23	"documents": [
24	{
25	"name": "purchase_order.pdf",
26	"index": 0,
27	"field_groups": [],
28	"form_fields": [],
29	"custom_fields": [
30	{
31	"type": "text",
32	"api_id": "b0e195cf-fb85-4dd4-94ab-6f62450c7059",
33	"avg_text_length": {
34	"num_lines": 1,
35	"num_chars_per_line": 22
36	},
37	"fontFamily": "arial",
38	"group": null,
39	"height": 14,
40	"isMultiline": false,
41	"name": "Cost",
42	"originalFontSize": 12,
43	"required": false,
44	"signer": null,
45	"width": 84,
46	"x": 378,
47	"y": 36
48	}
49	]
50	}
51	],
52	"accounts": [
53	{
54	"account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
55	"email_address": "me@dropboxsign.com",
56	"is_locked": false,
57	"is_paid_hs": true,
58	"is_paid_hf": false,
59	"quotas": {
60	"api_signature_requests_left": 0,
61	"documents_left": 3600000,
62	"sms_verifications_left": 300000
63	}
64	}
65	]
66	},
67	{
68	"template_id": "f57db65d3f933b5316d398057a36176831451a35",
69	"title": "Mutual NDA",
70	"message": "Please sign this NDA as soon as possible.",
71	"updated_at": 1570471067,
72	"is_embedded": false,
73	"is_creator": true,
74	"can_edit": true,
75	"is_locked": false,
76	"metadata": {},
77	"signer_roles": [
78	{
79	"name": "Outside Vendor",
80	"order": 0
81	},
82	{
83	"name": "Internal Manager",
84	"order": 1
85	}
86	],
87	"cc_roles": [
88	{
89	"name": "Corporate Attorney"
90	}
91	],
92	"documents": [
93	{
94	"name": "mutual_nda.pdf",
95	"index": 0,
96	"field_groups": [
97	{
98	"name": "group1",
99	"rule": {}
100	}
101	],
102	"form_fields": [
103	{
104	"type": "checkbox",
105	"api_id": "b65e03_10",
106	"group": "group1",
107	"height": 15,
108	"name": "DepartmentA",
109	"required": false,
110	"signer": "1",
111	"width": 15,
112	"x": 117,
113	"y": 19
114	},
115	{
116	"type": "checkbox",
117	"api_id": "b65e03_11",
118	"group": "group1",
119	"height": 15,
120	"name": "DepartmentB",
121	"required": false,
122	"signer": "2",
123	"width": 15,
124	"x": 118,
125	"y": 41
126	},
127	{
128	"type": "text",
129	"api_id": "0ec7a7_1",
130	"avg_text_length": {
131	"num_lines": 1,
132	"num_chars_per_line": 19
133	},
134	"fontFamily": "arial",
135	"group": null,
136	"height": 30,
137	"isMultiline": false,
138	"name": "VendorName",
139	"originalFontSize": 12,
140	"required": true,
141	"signer": "1",
142	"width": 80,
143	"x": 160,
144	"y": 141
145	},
146	{
147	"type": "text",
148	"api_id": "0ec7a7_2",
149	"avg_text_length": {
150	"num_lines": 1,
151	"num_chars_per_line": 19
152	},
153	"fontFamily": "arial",
154	"group": null,
155	"height": 30,
156	"isMultiline": false,
157	"name": "VendorTitle",
158	"originalFontSize": 12,
159	"required": true,
160	"signer": "2",
161	"width": 80,
162	"x": 160,
163	"y": 181
164	},
165	{
166	"type": "text",
167	"api_id": "0ec7a7_3",
168	"avg_text_length": {
169	"num_lines": 1,
170	"num_chars_per_line": 19
171	},
172	"fontFamily": "arial",
173	"group": null,
174	"height": 30,
175	"isMultiline": false,
176	"name": "ManagerName",
177	"originalFontSize": 12,
178	"required": true,
179	"signer": "2",
180	"width": 80,
181	"x": 160,
182	"y": 221
183	},
184	{
185	"type": "text",
186	"api_id": "0ec7a7_4",
187	"avg_text_length": {
188	"num_lines": 1,
189	"num_chars_per_line": 19
190	},
191	"fontFamily": "arial",
192	"group": null,
193	"height": 30,
194	"isMultiline": false,
195	"name": "ManagerTitle",
196	"originalFontSize": 12,
197	"required": true,
198	"signer": "2",
199	"width": 80,
200	"x": 160,
201	"y": 251
202	},
203	{
204	"type": "date_signed",
205	"api_id": "0ec7a7_5",
206	"group": null,
207	"height": 16,
208	"name": "DateSigned",
209	"required": true,
210	"signer": "1",
211	"width": 105,
212	"x": 523,
213	"y": 28
214	}
215	],
216	"custom_fields": [
217	{
218	"type": "text",
219	"api_id": "78083014-32d8-4b5b-b65e-fe6010f3be64",
220	"avg_text_length": {
221	"num_lines": 1,
222	"num_chars_per_line": 22
223	},
224	"fontFamily": "arial",
225	"group": null,
226	"height": 14,
227	"isMultiline": false,
228	"name": "Effective Date",
229	"originalFontSize": 12,
230	"required": false,
231	"signer": null,
232	"width": 84,
233	"x": 378,
234	"y": 36
235	}
236	]
237	}
238	],
239	"accounts": [
240	{
241	"account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
242	"email_address": "me@dropboxsign.com",
243	"is_locked": false,
244	"is_paid_hs": true,
245	"is_paid_hf": false,
246	"quotas": {
247	"api_signature_requests_left": 0,
248	"documents_left": 3600000,
249	"sms_verifications_left": 300000
250	}
251	}
252	]
253	}
254	],
255	"list_info": {
256	"num_pages": 1,
257	"num_results": 2,
258	"page": 1,
259	"page_size": 20
260	}
261	}