Template Properties
GET {{apiBaseUrl}}/v1/template/properties?templateId={{templateId}}
The template entire details, such as its title, description, role details, added form fields .. etc., can be fetched by specifying the template ID.
On successful get, the entire template details will be returned.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
templateId | string | The ID of the template from which the details should be fetched. |
RESPONSES
status: OK
{"templateId":"b393ea19-xxxx-xxxx-xxxx-050a3d79d778","title":"Onboarding Agreement","description":"This template is applicable to new employees.","documentTitle":"Onboarding Agreement","documentMessage":"","files":[{"documentName":"Onboarding Agreement.pdf","order":0,"pageCount":1}],"roles":[{"name":"New employee","index":1,"defaultSignerName":"","defaultSignerEmail":"","phoneNumber":null,"signerOrder":1,"signerType":"Signer","hostEmail":"","hostName":"","language":1,"locale":"EN","allowRoleEdit":true,"allowRoleDelete":true,"enableAccessCode":false,"enableEmailOTP":false,"imposeAuthentication":"None","deliveryMode":"Email","allowFieldConfiguration":false,"formFields":[{"id":"Name1","fieldType":"textbox","type":"name","value":"","font":"Helvetica","isRequired":true,"isReadOnly":false,"lineHeight":14,"fontSize":13,"fontHexColor":"#000000","isUnderLineFont":false,"isItalicFont":false,"isBoldFont":false,"groupName":"","label":"","placeholder":"","validationtype":"None","validationCustomRegex":"","validationCustomRegexMessage":"","dateFormat":"","timeFormat":"","imageInfo":null,"attachmentInfo":null,"editableDateFieldSettings":null,"dropdownOptions":[],"bounds":{"x":142.86499,"y":506.5,"width":49.6875,"height":17},"pageNumber":1,"conditionalRules":[],"dataSyncTag":"","textAlign":"Left","textDirection":"LTR","characterSpacing":0,"characterLimit":0,"hyperlinkText":"","backgroundHexColor":null},{"id":"Email1","fieldType":"textbox","type":"email","value":"","font":"Helvetica","isRequired":true,"isReadOnly":false,"lineHeight":14,"fontSize":13,"fontHexColor":"#000000","isUnderLineFont":false,"isItalicFont":false,"isBoldFont":false,"groupName":"","label":"","placeholder":"","validationtype":"None","validationCustomRegex":"","validationCustomRegexMessage":"","dateFormat":"","timeFormat":"","imageInfo":null,"attachmentInfo":null,"editableDateFieldSettings":null,"dropdownOptions":[],"bounds":{"x":139.78271,"y":535.5,"width":47.515625,"height":17},"pageNumber":1,"conditionalRules":[],"dataSyncTag":"","textAlign":"Left","textDirection":"LTR","characterSpacing":0,"characterLimit":0,"hyperlinkText":"","backgroundHexColor":null}],"enableEditRecipients":true,"enableDeleteRecipients":true,"recipientNotificationSettings":null}],"formGroups":[],"commonFields":[{"id":"JobTitle1","fieldType":"label","type":"label","value":"","font":"Helvetica","isRequired":true,"isReadOnly":false,"lineHeight":14,"fontSize":13,"fontHexColor":"#000000","isUnderLineFont":false,"isItalicFont":false,"isBoldFont":false,"groupName":"","label":"","placeholder":"","validationtype":"None","validationCustomRegex":"","validationCustomRegexMessage":"","dateFormat":"","timeFormat":"","imageInfo":null,"attachmentInfo":null,"editableDateFieldSettings":null,"dropdownOptions":[],"bounds":{"x":153.5,"y":566.5,"width":80,"height":17},"pageNumber":1,"conditionalRules":[],"dataSyncTag":"","textAlign":"Left","textDirection":"LTR","characterSpacing":0,"characterLimit":0,"hyperlinkText":"","backgroundHexColor":null},{"id":"JoiningDate1","fieldType":"label","type":"label","value":"","font":"Helvetica","isRequired":true,"isReadOnly":false,"lineHeight":14,"fontSize":13,"fontHexColor":"#000000","isUnderLineFont":false,"isItalicFont":false,"isBoldFont":false,"groupName":"","label":"","placeholder":"","validationtype":"None","validationCustomRegex":"","validationCustomRegexMessage":"","dateFormat":"","timeFormat":"","imageInfo":null,"attachmentInfo":null,"editableDateFieldSettings":null,"dropdownOptions":[],"bounds":{"x":178.5,"y":624.5,"width":117,"height":21},"pageNumber":1,"conditionalRules":[],"dataSyncTag":"","textAlign":"Left","textDirection":"LTR","characterSpacing":0,"characterLimit":0,"hyperlinkText":"","backgroundHexColor":null}],"cCDetails":[],"brandId":"8f692627-c9a4-4599-9243-ca73395258c6","allowMessageEditing":true,"allowNewRoles":true,"allowNewFiles":true,"allowModifyFiles":true,"enableReassign":true,"EnablePrintAndSign":false,"enableSigningOrder":false,"createdDate":1701080612,"createdBy":{"emailAddress":"cathysam@cubeflakes.com","name":"Cathy Sam"},"sharedTemplateDetail":[],"documentInfo":[{"language":1,"locale":"EN","title":"Onboarding Agreement","description":""}],"labels":[],"templateLabels":[],"behalfOf":null,"documentDownloadOption":"Combined","recipientNotificationSettings":null}