Template List
GET {{apiBaseUrl}}/v1/template/list?pageSize=10&page=1
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
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
pageSize | number | The maximum number of Template objects in a page (10 by default). | |
The value must be between 1 and 100. | |||
page | number | The page number (starting with 1) that you would like to view. |
RESPONSES
status: OK
{"pageDetails":{"pageSize":10,"page":1,"totalRecordsCount":2,"totalPages":1,"sortedColumn":"activityDate","sortDirection":"DESC"},"result":[{"documentId":"85990d17-9655-4089-853f-e843f202d0dd","senderDetail":{"name":"Cathy Sam","emailAddress":"cathysam@cubeflakes.com","userId":"60c2c811-42e9-495b-a8ff-80e851b5c0aa"},"ccDetails":[{"emailAddress":"luthercooper@cubeflakes.com","userId":null}],"createdDate":1721710229,"activityDate":1721710229,"activityBy":"cathysam@cubeflakes.com","messageTitle":"Indo-European language family","status":"Completed","signerDetails":[{"signerName":"Alex Gayle","signerRole":"HR","signerEmail":"alexgayle@cubeflakes.com","phoneNumber":null,"status":"NotCompleted","enableAccessCode":false,"enableEmailOTP":false,"imposeAuthentication":"None","deliveryMode":"Email","allowFieldConfiguration":false,"userId":null,"order":1,"signerType":"Signer","hostEmail":null,"hostName":null,"hostUserId":null,"signType":"Single"}],"enableSigningOrder":false,"templateName":"LLC Operating Agreement","templateDescription":"An LLC operating agreement is a legal document that governs the affairs, management, and ownership of a company.","accessType":"Edit","accessTid":"","isTemplate":false,"behalfOf":null,"templateLabels":["tempLabel1"],"labels":["label1"]},{"documentId":"b393ea19-4181-4053-af03-050a3d79d778","senderDetail":{"name":"Cathy Sam","emailAddress":"cathysam@cubeflakes.com","userId":"60c2c811-42e9-495b-a8ff-80e851b5c0aa"},"ccDetails":[],"createdDate":1701080612,"activityDate":1718181463,"activityBy":"cathysam@cubeflakes.com","messageTitle":"Onboarding Agreement","status":"Completed","signerDetails":[{"signerName":"","signerRole":"New employee","signerEmail":"","phoneNumber":null,"status":"NotCompleted","enableAccessCode":false,"enableEmailOTP":false,"imposeAuthentication":"None","deliveryMode":"Email","allowFieldConfiguration":false,"userId":null,"order":1,"signerType":"Signer","hostEmail":null,"hostName":null,"hostUserId":null,"signType":"Single"}],"enableSigningOrder":false,"templateName":"Onboarding Agreement","templateDescription":"This template is applicable to new employees.","accessType":"Edit","accessTid":"","isTemplate":false,"behalfOf":null,"templateLabels":[],"labels":[]}]}