List templates
get/v1/template/listThis function returns a paginated list of templates from your account. You can also search the templates associated with an account using one or more supported query filters. Calling list templates without any explicit query filter returns all templates.
The list can be filtered by the following values:
1. TemplateId 2. TemplateName
Code snippet
curl -X 'GET' \ 'https://api.boldsign.com/v1/template/list?PageSize=10&Page=1' \ -H 'accept: application/json' \ -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "API-KEY"); var templateClient = new TemplateClient(apiClient); var templates = templateClient.ListTemplates(1, 10);
import requests url = "https://api.boldsign.com/v1/template/list?PageSize=10&Page=1" payload={} headers = { 'accept': 'application/json', 'X-API-KEY': '<API-KEY>' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
const axios = require('axios'); const response = await axios.get('https://api.boldsign.com/v1/template/list', { params: { 'PageSize': '10', 'Page': '1' }, headers: { 'accept': 'application/json', 'X-API-KEY': '<API-KEY>' } });
Query parameters
Pageinteger | The page number (starting with 1) that you would like to view. |
PageSizeinteger | The maximum number of The value must be between 1 and 100. |
TemplateTypestring | The default value is
|
SearchKeystring | It will return a list of template objects based on the key values you provide, such as template Id and template name. |
Example response
200 Success
{ "pageDetails": { "pageSize": 10, "page": 1, "totalRecordsCount": 52, "totalPages": 6, "sortedColumn": "activityDate", "sortDirection": "DESC" }, "result": [ { "documentId": "4e2375dd-xxxx-xxxx-xxxx-870952cee6f8", "senderDetail": { "name": "Alex Gayle", "emailAddress": "alexgayle@cubeflakes.com", "userId": "4383962c-xxxx-xxxx-xxxx-e0cd3f170f0f" }, "ccDetails": [], "createdDate": 1665465712, "activityDate": 1665465712, "activityBy": "alexgayle@cubeflakes.com", "messageTitle": "Bill-of-Sale", "status": "Completed", "signerDetails": [ { "signerName": "Hank White", "signerRole": "Hr", "signerEmail": "hankwhite@cubeflakes.com", "status": "NotCompleted", "enableAccessCode": false, "enableEmailOTP": false, "imposeAuthentication": "None", "userId": null, "order": 1, "signerType": "Signer", "language": 1, "hostEmail": "", "hostName": "", "hostUserId": "", "allowRoleEdit": true, "allowRoleDelete": true }, { "signerName": "Luther Cooper", "signerRole": "Sales", "signerEmail": "luthercooper@cubeflakes.com", "status": "NotCompleted", "enableAccessCode": false, "enableEmailOTP": false, "imposeAuthentication": "None", "userId": null, "order": 2, "signerType": "Signer", "language": 1, "hostEmail": "", "hostName": "", "hostUserId": "", "allowRoleEdit": true, "allowRoleDelete": true } ], "enableSigningOrder": false, "enableReassign": true, "templateName": "Name of the template", "templateDescription": "template description", "accessType": "Edit", "accessTid": "", "isTemplate": false } ] }