OpenSign/assets/js/377084eb.a6437b0c.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9441],{4741:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>b,default:()=>P,frontMatter:()=>u,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":"eJzVWO9u2zgSf5VZftltofhP6qZ7/rTBXZENrrgWmywKbGoYFDWW2FAkl6T8B4aA+3BvcG9wj7ZPchjKkuU4jRvsocB9SSxqhvOb/zPassBzz6Z37BZLq3hAz2YJy9ALJ22QRrMpuy0QrjBASwKXH66BK2VWHjamgmDAYXASlwgZBi6VB56aKgAHb1HIhRQQdsyD7hoPHt0SgXtIVYXWSR08LIwD4ZAHqXPIjKhKpOOVDAVYhxkupMYMfHCVCJVDP2AJMxYdJ7TXGZuyHEMrgyXMcsdLDOhIzS3TvEQ2ZS2cucxYwiSpaXko2EPdr/8GZtGBh1DwABox86R1irDAIAqkOxz+XkmHGZsGV2HCfNgokuRlaRUBwbVVJkM2XXDliUAUWHI23bKwsZEyOKlzlrCFcSUPzYnOWV3P6HpvjfboieF8NKJ/h1B9JQR6v6gUdPZgCRNGB9SB6Lm1Sor4YvjZE9P2GIVJP6MIZDhH1wTZiGyOyb5P421OcM2j1lO2Hv+c6tKff8hZnbAgA50eX7Fn8PFHZ3Li0iacYOocFElrgqQydN9KrSaongLY4IFIWO8NsY/DHWCCLk+ZqAjB+ulw2DJXHt1AmJK4zUof6P2UsWKemRZVwrzMdcyTjps7xzeUIAFLf9qazpyCLtB8ncE+G4QUIywsuVQnqVPEn3YHrS1sYfQJMZPXF+fjVz++GRP9SmY5hj+hf/P2WN5hol5S6cQMllxV6OEMyO6cilkCPvDSDk4EX0dPoNc9gboqU3R97u6k4z6fTOqEbZ7J9WZM9nkm06sf64QVz2SaXJDneI7P5Bs/mlY3TUjPW9fWT1HFzPSos2v93h2Wj9QYhVz3BVKZrxMWkwizy/B0oJ2Pzl+djUdnoze344vp5C/T1xeD0Wj0G0vYuozRvetM2a7otSDb58pm30QOap4qvDXV16nvMJMORZhX7tEcfSqOSVycI+alyWhKiK3JPy03dk9irIKZOyylPumplqWhnhstcC71HJfoHs2DjnFEAXFotn5fehhHFF11wiaPdecbU2IoaKhZoQ6wckbnCViF3CMEtwGec6mBrnHf/e/aNjpnTrSD5yHr54/USmqct6PJfDIazcedESbHRrjttWlYmEpn31bVx+Q/rdBkftEp9PpYoWu95EpmcSK+Nfeov60+ffGhEX8csbIhiu/ZgbL980ZJj6JyMmziqLw+41aeNe+ndzOaQilSzG7GjrN1KNiUdYPIcNubq2tG97llO3nHAtHNLp7rLDXrgbGoqZ8pnnrq20Nu5XBJ7fghB7f2GdRYnT2PwQeeS50/zTXbm+iG3Nh46sBQ+9nByr8jDQ87P/SpditHgTwOfTU9L0xk3nnnvUVNbSn6djk+GiI+ohKmRFpDQoHQkv/xr/9EjnZziqH33Sf9Sb+vHFizQkcLAtcZLBSuZaqadQ7L+K5b6DzyUqH3agNSB8wdZU0mcxm4ivMK1QvBLU+lkhSxRGaI20Ev6P0APhYYCnT06nuHwCHDJSoKdKASXh5uerAy7n5Bq2UCHNLKS43eA+qCa0GErfkTMA64BtQBnXXSI+2EhFo22IwOjosAJdc8R7o7ObBShkpSbIIzaeUDeKOqCBlogzUOM2gVigvfgIz4lnY4h0CnwpTWYUGRskTIK5mhT0CYDKHZYUgFnUGKPoAlLFJg3BsrrYy4j35bVEqBNVQvJFe0a/YxEntwXHvqog2W1gedwawztPZhA/Dly189koffSX3vpy9fftJncNcF00dMvQw4+6GN+tVqdRTtLw55rmT4uUrhF7TGy2DcZs+dy1BUacyQ/iXdQ3PTFWqM8dPLgP0dmRH+OOHodFigssMbDBQhfnj54TqW2Bfwxz//De+QOw2FWTXRKiqHagN5K4os13i+MVtXIeMHBl6FgiwumuCj1R19IAvSmHSYzYdp53CBjowfHbkXZ+Xu+rsWJhD6P6Mm1WqKYi5iK9ltQVRWfnp4Tyzr6Er/fnGDbilFuyV+wcPDSDxkCVNSoPbYaxeXVx/ewRJeDUYs6ZXIr/D28N31X9/+4+YtoaHMaiw2HowGo7iNGR9Krnui+h+VHha47b6N/h98gNqV/IDrMLSKy9hodxNx0yTv9lNiwqb9z0+zhBXGByLZblPu8Ven6pqOf6/igHo3S9iSO0lzeeykmfT0O+s+JX3Rcj/8svsq9QK+/kvWo8q0TU1TR4ubKw3wCbvHzYPPafWMtr6msxHahuJSCLShx3s0Gh3MF1dvb1mc8YvDjnofO+ruB93+KK7DVtsAoL/U9R9l2G6bbl3XHX3z6oscOwVbajLSrK7r/wKxyGq/","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),o=a(28453),i=a(33617),s=a.n(i),p=a(17543),l=a.n(p),m=a(86013),c=a.n(m),d=a(63723),h=a.n(d),f=(a(18766),a(79329),a(9303));const u={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:"eJzVWO9u2zgSf5VZftltofhP6qZ7/rTBXZENrrgWmywKbGoYFDWW2FAkl6T8B4aA+3BvcG9wj7ZPchjKkuU4jRvsocB9SSxqhvOb/zPassBzz6Z37BZLq3hAz2YJy9ALJ22QRrMpuy0QrjBASwKXH66BK2VWHjamgmDAYXASlwgZBi6VB56aKgAHb1HIhRQQdsyD7hoPHt0SgXtIVYXWSR08LIwD4ZAHqXPIjKhKpOOVDAVYhxkupMYMfHCVCJVDP2AJMxYdJ7TXGZuyHEMrgyXMcsdLDOhIzS3TvEQ2ZS2cucxYwiSpaXko2EPdr/8GZtGBh1DwABox86R1irDAIAqkOxz+XkmHGZsGV2HCfNgokuRlaRUBwbVVJkM2XXDliUAUWHI23bKwsZEyOKlzlrCFcSUPzYnOWV3P6HpvjfboieF8NKJ/h1B9JQR6v6gUdPZgCRNGB9SB6Lm1Sor4YvjZE9P2GIVJP6MIZDhH1wTZiGyOyb5P421OcM2j1lO2Hv+c6tKff8hZnbAgA50eX7Fn8PFHZ3Li0iacYOocFElrgqQydN9KrSaongLY4IFIWO8NsY/DHWCCLk+ZqAjB+ulw2DJXHt1AmJK4zUof6P2UsWKemRZVwrzMdcyTjps7xzeUIAFLf9qazpyCLtB8ncE+G4QUIywsuVQnqVPEn3YHrS1sYfQJMZPXF+fjVz++GRP9SmY5hj+hf/P2WN5hol5S6cQMllxV6OEMyO6cilkCPvDSDk4EX0dPoNc9gboqU3R97u6k4z6fTOqEbZ7J9WZM9nkm06sf64QVz2SaXJDneI7P5Bs/mlY3TUjPW9fWT1HFzPSos2v93h2Wj9QYhVz3BVKZrxMWkwizy/B0oJ2Pzl+djUdnoze344vp5C/T1xeD0Wj0G0vYuozRvetM2a7otSDb58pm30QOap4qvDXV16nvMJMORZhX7tEcfSqOSVycI+alyWhKiK3JPy03dk9irIKZOyylPumplqWhnhstcC71HJfoHs2DjnFEAXFotn5fehhHFF11wiaPdecbU2IoaKhZoQ6wckbnCViF3CMEtwGec6mBrnHf/e/aNjpnTrSD5yHr54/USmqct6PJfDIazcedESbHRrjttWlYmEpn31bVx+Q/rdBkftEp9PpYoWu95EpmcSK+Nfeov60+ffGhEX8csbIhiu/ZgbL980ZJj6JyMmziqLw+41aeNe+ndzOaQilSzG7GjrN1KNiUdYPIcNubq2tG97llO3nHAtHNLp7rLDXrgbGoqZ8pnnrq20Nu5XBJ7fghB7f2GdRYnT2PwQeeS50/zTXbm+iG3Nh46sBQ+9nByr8jDQ87P/SpditHgTwOfTU9L0xk3nnnvUVNbSn6djk+GiI+ohKmRFpDQoHQkv/xr/9EjnZziqH33Sf9Sb+vHFizQkcLAtcZLBSuZaqadQ7L+K5b6DzyUqH3agNSB8wdZU0mcxm4ivMK1QvBLU+lkhSxRGaI20Ev6P0APhYYCnT06nuHwCHDJSoKdKASXh5uerAy7n5Bq2UCHNLKS43eA+qCa0GErfkTMA64BtQBnXXSI+2EhFo22IwOjosAJdc8R7o7ObBShkpSbIIzaeUDeKOqCBlogzUOM2gVigvfgIz4lnY4h0CnwpTWYUGRskTIK5mhT0CYDKHZYUgFnUGKPoAlLFJg3BsrrYy4j35bVEqBNVQvJFe0a/YxEntwXHvqog2W1gedwawztPZhA/Dly189koffSX3vpy9fftJncNcF00dMvQw4+6GN+tVqdRTtLw55rmT4uUrhF7TGy2DcZs+dy1BUacyQ/iXdQ3PTFWqM8dPLgP0dmRH+OOHodFigssMbDBQhfnj54TqW2Bfwxz//De+QOw2FWTXRKiqHagN5K4os13i+MVtXIeMHBl6FgiwumuCj1R19IAvSmHSYzYdp53CBjowfHbkXZ+Xu+rsWJhD6P6Mm1WqKYi5iK9ltQVRWfnp4Tyzr6Er/fnGDbilFuyV+wcPDSDxkCVNSoPbYaxeXVx/ewRJeDUYs6ZXIr/D28N31X9/+4+YtoaHMaiw2HowGo7iNGR9Krnui+h+VHha47b6N/h98gNqV/IDrMLSKy9hodxNx0yTv9lNiwqb9z0+zhBXGByLZblPu8Ven6pqOf6/igHo3S9iSO0lzeeykmfT0O+s+JX3Rcj/8svsq9QK+/kvWo8q0TU1TR4ubKw3wCbvHzYPPafWMtr6msxHahuJSCLShx3s0Gh3MF1dvb1mc8YvDjnofO+ruB93+KK7DVtsAoL/U9R9l2G6bbl3XHX3z6oscOwVbajLSrK7r/wKxyGq/",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,g={},y=[];function S(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,r.jsx)(s(),{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)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{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)(c(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(h(),{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},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},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 P(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(S,{...e})}):S(e)}}}]);