OpenSign/assets/js/377084eb.71fcd1cb.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9441],{4741:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>b,contentTitle:()=>x,default:()=>v,frontMatter:()=>f,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/get-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-template","permalink":"/docs/API-docs/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWFtv3DYW/iunfNkGkOfiTJzuPNVog6yxxSZYexFgk4FBSWdGjCmSJY/mgoHe+kv60/pLikNdrPE44xi7CNAXe0Sd79xv1F6QXAUx/yhusHRaEgaxSESOIfPKkbJGzMVNgfAWCToSuHx/BVJruwmwsxWQBY/kFa4RciSpdACZ2opAQnCYqaXKgFrwqGcTIKBfI8gAqa7QeWUowNJ6yDxKUmYFuc2qEvl4o6gA5zHHpTKYQyBfZVR5DCORCOvQS9b2KhdzsULqZIhEOOlliYSezdwLI0sUc9Gpc6tykQjFZjpJhXho+9XPYJe98kCFJDCIeWCrU4QlUlYg8/D4a6U85mJOvsJEBNpplhRU6TQrglunbY5ivpQ6MEFWYCnFfC9o5yIleWVWIhFL60tJzYlZibpeMPvgrAkYGHA+mfC/Q1VDlWUYwrLS0PtDJCKzhtAQ00vntMrii/HnwKD9sRY2/YwZseM8syHViGyO2b+n9W1OcCuj1XOxnf4jNWU4f78SdSJIEZ8es7gHhPijdzmjjKUnQH2AImnNKukc/bcyq0mqUwo2+kAkrO8dcZ+HrcKsunrKRQWRC/PxuANXAf0osyWj7cYc2H3KWbHObKdVIoJamVgnPVp6L3dcIIRleNqb3j6leob26xz22SKkGNXCUir9JHWK+GN70PnCFdY8IWb26uJ8+vKH11Om36h8hfQ/2N+8PZZ3WKiX3Doxh7XUFQY4A/a75GaWQCBZutETydfTs9LbgUBTlSn6Ibo/6dHns1mdiN0zUa+n7J9ngl7+UCeieCZodsGRkyt8Jm76aFldNyl924W2PkUVKzOgya/MO3/YPlJrNUozFMhtvk5ELCLML+l0op1Pzl+eTSdnk9c304v57O/zVxejyWTyX5GIbRmzu51Medv0OiW758rl30QOGplqvLHV15nvMVceM7qt/KM1eiqPWVzcI25Lm/OWEEdTOC03Tk8O1KE5w3nxML4c9ToRs8em5rUtkQpeNjZoCDbemlUCTqMMCOR3IFdSGWA2/rv/3zhF7+0Tbfp5mg3zWhmtDN52K8PtbDK5nfZOmB074WYwPmFpK5N/W1Mfk3/aoNntRW/Qq2ODrsxaapXHTfXG3qH5tvYMxVMj/jhjVUMU34sDY4fnjZEBs8or2sUVdnsmnTpr3s8/Lng75Eyx7e4bd14qxFz0C8J4P9h3a8H8/LrbiGPh9jtFkCZP7XZkHRqeM1qmgefpWDo1XvOYfIiQzj2DGquz5wECyZUyq9Ooxb2LrjmMTaQOHHU/0536J/JQb+MwpGqvAgXKuIzV/Ly0EdxG551Dw+MixnY9PRruH1BntkS+HlCB0JH/8dvvEdHdaGLqfQfvKg/ObtDz1i5NDkuNW5Xqx+5YAWWpMQS9A2UIV54LJlcrRVLHFYJbRSadTJVWnKxMZhntYZDvYQQfCqQCPb/6m0eQkOMaNec4aGvvmA9ZkBXZMspodYaN9XdLVikBCWkVlMHAtzjsIGgKaTKELhYJWA/SABpC77wKCFKVTMzXPFwuVaaYMVemlxlBKY1cIQtLgPVmLzhv1yrHAN6mVSAIVlfREJZYIlJjYryVjeBntcbGcD5srqOYw6piFglkNkdoC5XNMDmkGAgci1cZRqaBpCfQuEYfcy9GcllpDc5yB1FS861wGFtmRF6awPOuUagLTe8+5y1f0KKMXO5G8Ml8MtzloQrICaCVuQvzT+YMPvZp9gHToAgX33f1sNlsjurgxSHmraKiSsGjs/e4VTyMVTOE9w8vRCIIfRneLa/Rr1XW3TS+IHMcicdtX5VZ7Kvtqs419uNDAPc4rTI0AQdd8PLt+19gDS9HE5EMKv8rFB7/cvXTm39dv2G+3Mya+puOJqNJXP5toFKagajhN4yHdbu/nw5/ge8dbScj3NLYaani/GgXsKb3f7xffhIxH37tWCSisIGYZL9PZcD/eF3XfPxrhZ4nzCIRa+kVr4FxQOQq8O+8/3LxRc99/+/2I8gL+PoPJ48a0/Vqw406XpR4X0zEHe4efL2pF3zJaBo2a9tQXGYZOhpgjyb+wdh8++ZGJEJWVBwOirs4KNofzP1RvQ4nSKMA/+Vh9ihgv2+GUF339M2rLyJaAztqdtKirus/AVH81uQ=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/update-template"}}');var r=a(74848),s=a(28453),p=a(33617),i=a.n(p),l=a(17543),o=a.n(l),m=a(86013),d=a.n(m),c=a(63723),g=a.n(c),u=(a(18766),a(79329),a(9303));const f={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWFtv3DYW/iunfNkGkOfiTJzuPNVog6yxxSZYexFgk4FBSWdGjCmSJY/mgoHe+kv60/pLikNdrPE44xi7CNAXe0Sd79xv1F6QXAUx/yhusHRaEgaxSESOIfPKkbJGzMVNgfAWCToSuHx/BVJruwmwsxWQBY/kFa4RciSpdACZ2opAQnCYqaXKgFrwqGcTIKBfI8gAqa7QeWUowNJ6yDxKUmYFuc2qEvl4o6gA5zHHpTKYQyBfZVR5DCORCOvQS9b2KhdzsULqZIhEOOlliYSezdwLI0sUc9Gpc6tykQjFZjpJhXho+9XPYJe98kCFJDCIeWCrU4QlUlYg8/D4a6U85mJOvsJEBNpplhRU6TQrglunbY5ivpQ6MEFWYCnFfC9o5yIleWVWIhFL60tJzYlZibpeMPvgrAkYGHA+mfC/Q1VDlWUYwrLS0PtDJCKzhtAQ00vntMrii/HnwKD9sRY2/YwZseM8syHViGyO2b+n9W1OcCuj1XOxnf4jNWU4f78SdSJIEZ8es7gHhPijdzmjjKUnQH2AImnNKukc/bcyq0mqUwo2+kAkrO8dcZ+HrcKsunrKRQWRC/PxuANXAf0osyWj7cYc2H3KWbHObKdVIoJamVgnPVp6L3dcIIRleNqb3j6leob26xz22SKkGNXCUir9JHWK+GN70PnCFdY8IWb26uJ8+vKH11Om36h8hfQ/2N+8PZZ3WKiX3Doxh7XUFQY4A/a75GaWQCBZutETydfTs9LbgUBTlSn6Ibo/6dHns1mdiN0zUa+n7J9ngl7+UCeieCZodsGRkyt8Jm76aFldNyl924W2PkUVKzOgya/MO3/YPlJrNUozFMhtvk5ELCLML+l0op1Pzl+eTSdnk9c304v57O/zVxejyWTyX5GIbRmzu51Medv0OiW758rl30QOGplqvLHV15nvMVceM7qt/KM1eiqPWVzcI25Lm/OWEEdTOC03Tk8O1KE5w3nxML4c9ToRs8em5rUtkQpeNjZoCDbemlUCTqMMCOR3IFdSGWA2/rv/3zhF7+0Tbfp5mg3zWhmtDN52K8PtbDK5nfZOmB074WYwPmFpK5N/W1Mfk3/aoNntRW/Qq2ODrsxaapXHTfXG3qH5tvYMxVMj/jhjVUMU34sDY4fnjZEBs8or2sUVdnsmnTpr3s8/Lng75Eyx7e4bd14qxFz0C8J4P9h3a8H8/LrbiGPh9jtFkCZP7XZkHRqeM1qmgefpWDo1XvOYfIiQzj2DGquz5wECyZUyq9Ooxb2LrjmMTaQOHHU/0536J/JQb+MwpGqvAgXKuIzV/Ly0EdxG551Dw+MixnY9PRruH1BntkS+HlCB0JH/8dvvEdHdaGLqfQfvKg/ObtDz1i5NDkuNW5Xqx+5YAWWpMQS9A2UIV54LJlcrRVLHFYJbRSadTJVWnKxMZhntYZDvYQQfCqQCPb/6m0eQkOMaNec4aGvvmA9ZkBXZMspodYaN9XdLVikBCWkVlMHAtzjsIGgKaTKELhYJWA/SABpC77wKCFKVTMzXPFwuVaaYMVemlxlBKY1cIQtLgPVmLzhv1yrHAN6mVSAIVlfREJZYIlJjYryVjeBntcbGcD5srqOYw6piFglkNkdoC5XNMDmkGAgci1cZRqaBpCfQuEYfcy9GcllpDc5yB1FS861wGFtmRF6awPOuUagLTe8+5y1f0KKMXO5G8Ml8MtzloQrICaCVuQvzT+YMPvZp9gHToAgX33f1sNlsjurgxSHmraKiSsGjs/e4VTyMVTOE9w8vRCIIfRneLa/Rr1XW3TS+IHMcicdtX5VZ7Kvtqs419uNDAPc4rTI0AQdd8PLt+19gDS9HE5EMKv8rFB7/cvXTm39dv2G+3Mya+puOJqNJXP5toFKagajhN4yHdbu/nw5/ge8dbScj3NLYaani/GgXsKb3f7xffhIxH37tWCSisIGYZL9PZcD/eF3XfPxrhZ4nzCIRa+kVr4FxQOQq8O+8/3LxRc99/+/2I8gL+PoPJ48a0/Vqw406XpR4X0zEHe4efL2pF3zJaBo2a9tQXGYZOhpgjyb+wdh8++ZGJEJWVBwOirs4KNofzP1RvQ4nSKMA/+Vh9ihgv2+GUF339M2rLyJaAztqdtKirus/AVH81uQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,b={},y=[];function h(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,r.jsx)(i(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,r.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(o(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,r.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]);