Files
OpenSign/assets/js/770b40a9.e63b830b.js
T

1 line
9.1 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7605],{71625:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>b,contentTitle:()=>f,default:()=>v,frontMatter:()=>g,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","source":"@site/docs/API-docs/gettemplatelist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/gettemplatelist","permalink":"/docs/API-docs/gettemplatelist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar_label":"Get Template list","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWFtv2zYU/iunfNkKKLacJmnnpwZbkQUrlgDJUGBpEFDSscWGIjmS8gWG3vZL9tP2S4ZDXSzFTdxsRR/2kljk+XjuF3LDPJ87Nr1h11gYyT06dhuxDF1qhfFCKzZl1znCGXpoSeC9cB5OL8+BS6mXDta6BK/BorcCFwgcJFHoGfAFF5InEsG354/gOhcOZqVK6XwuhV+DsXohMnTAFegF2oXAZcBLuUVGgIonUqg5lA6tI55prrVDmFldAK6E87TbIWCZo4LUIg/rmU7LApV3IxYxbdBykuA8Y1M2R9+iSHYWMcMtL9CjJfNsmOIFsimTohC0K8gwf5Ro1yxiFv8ohcWMTWdcOoyY82tJ1DNtCxYxXBmpM2RTb0vaTXMsOJtuWMFXoigLNj2O44j5tSGQKosELasIxwtDB03iKupEcPfCfDUJHucZV7d0rjNaOXREexjH9G8YHK5MU3RuVkroLMoilmrlUXmi58ZIkYaN8SdHoM2uADr5hGkwu6VjvKhZWnSl9D06bi0nhYXHwu3H18vk4Y7SeSvUnEXBNNz3Vzrd2Wryc6IKd3g5J5t44Wl194gtwIUfXeQRSmm/B9RSQyCtSCSZof1WatXx9JSAtTwQCKutITrB7xqBSXSxz0S598ZNx+MWTDk8SnVBaL1UA72fMlZIZ91KFTEn5ipk6b8NEqv3iZ6i/jKDfdIICQaxsOBC7qVOEN82C60tTK7VHjZHxyeHk1dvXk+IfimyOfr/oH+9u8tvmOinVOsxgwWXJTo4ALI796XFCJznhRntCb6OnoRe7RafHrpb6dCHR0dVxNbPRL2ekH2eCXr1popY/kzQ0Ql5js/xmbjJZ9Pqqg7pu9a11VNUITMdquxcXdhh+Ui0lshVnyE1gCpiIYkwO/VPB9phfPjqYBIfxK+vJyfTox+mxyejOI5/ZxFbFSG6m6aUNUWvFbL9Lk32TfiEyQCvdfll6lvMhMXU35X2szn6VBwTuzD43BU6E7Omtbmn+Ya2TI4aqtPvFw/9O/S6UFIovGsb8t1hHN+dEEkVsaP4eLcxn6sFlyILc9q1vkf14uu1ZbRW7ynXffa+Zr+rvqiJwj4bKNtfr5V0mJZW+HWYxlYH3IiDen96c0ujSoE+180oF8Y3n7MpGz+Y6hzaRTvSBd93bclxlSV6NdIGFZUqyRNHJXnMjRgvqNI+RHBjnkGN5cHzAM7zuVDzp1G3W8NckfNq/wzMs20LRvyC1Bca6/epmnkyRx76eUXfMx3AjU8uDCqqOMGji8lOf/iAMtUF0lDuc4SW/O8//wqIdvYOAfcCLkoLRi/R0uDIVQYziStBF4Xde4VDXkh0Tq5BKI9zS1NAJubCcxm6EM32KTc8EVJQiBKZJrSFXpS7EXzI0edoaes7S/eUDBcoKbJBan0f7g4aeOl1EXg0MsNS2/sZiRQBh6R0QqFz4BBbCKqcqxSh9UUE2tJdBpVHa6xwCFwURDzTFnA2E6mggykfLU89FFzxORKzCEhuskJ3KbI6KZ0Hp2UZFCGOBaKvVVSImRvBT2KBteK0mKHnQmIG85KOiCDVGUKTnqSGyiBB58EQe5FiONR5bj1IXKANsRc8OSulBKOpbggu6VbW9y0d5C1XjkpmLVDrms58xmq6IwQeGV+P4KP6qK4oWEqHFABSqHs3/agO4KYLsw+YOOHx9vs2H5bL5U4evBxizoTPywQsGr3FzcNiyJo+vPt4SU1mmDDDyLY4Q0vaBBvNUWGIQG5EXdng5vTyPJRYyFGaLWeC7KYurY6JcHyFnu6lbtziX1IRpJjgaajRzQxJmfv24TmhXqIt3MXsii7MaTtjP2KqcSAes4hJkaJy2KvDp2eX72EBr0Yxi3pV6AuMN35//uO7X6/ekTRUWGuLTUbxKA6zrHa+4KrHavCQ0BTlgbk32yb1P315aMqxx5UfG8lFaH3NIFK3rRs2aFu3Ecu187S+2STc4W9WVhUt1/d/amaZcKTt9gXgHte994owtdfDy6O0zcPClvSWPqwg2tBlo7Y/EMMac5qmaPoMdsaKQW8+e3fNIsZLnw/70n3oS80POr3dUuve2cOGVQtAf0mnzwI2m7rnVVVHX289imgUbKnJN7dVVf0DL+uhcw==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/get-webhook"}}');var s=a(74848),n=a(28453),l=a(33617),o=a.n(l),r=a(17543),p=a.n(r),m=a(86013),c=a.n(m),d=a(63723),u=a.n(d),x=(a(18766),a(79329),a(9303));const g={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWFtv2zYU/iunfNkKKLacJmnnpwZbkQUrlgDJUGBpEFDSscWGIjmS8gWG3vZL9tP2S4ZDXSzFTdxsRR/2kljk+XjuF3LDPJ87Nr1h11gYyT06dhuxDF1qhfFCKzZl1znCGXpoSeC9cB5OL8+BS6mXDta6BK/BorcCFwgcJFHoGfAFF5InEsG354/gOhcOZqVK6XwuhV+DsXohMnTAFegF2oXAZcBLuUVGgIonUqg5lA6tI55prrVDmFldAK6E87TbIWCZo4LUIg/rmU7LApV3IxYxbdBykuA8Y1M2R9+iSHYWMcMtL9CjJfNsmOIFsimTohC0K8gwf5Ro1yxiFv8ohcWMTWdcOoyY82tJ1DNtCxYxXBmpM2RTb0vaTXMsOJtuWMFXoigLNj2O44j5tSGQKosELasIxwtDB03iKupEcPfCfDUJHucZV7d0rjNaOXREexjH9G8YHK5MU3RuVkroLMoilmrlUXmi58ZIkYaN8SdHoM2uADr5hGkwu6VjvKhZWnSl9D06bi0nhYXHwu3H18vk4Y7SeSvUnEXBNNz3Vzrd2Wryc6IKd3g5J5t44Wl194gtwIUfXeQRSmm/B9RSQyCtSCSZof1WatXx9JSAtTwQCKutITrB7xqBSXSxz0S598ZNx+MWTDk8SnVBaL1UA72fMlZIZ91KFTEn5ipk6b8NEqv3iZ6i/jKDfdIICQaxsOBC7qVOEN82C60tTK7VHjZHxyeHk1dvXk+IfimyOfr/oH+9u8tvmOinVOsxgwWXJTo4ALI796XFCJznhRntCb6OnoRe7RafHrpb6dCHR0dVxNbPRL2ekH2eCXr1popY/kzQ0Ql5js/xmbjJZ9Pqqg7pu9a11VNUITMdquxcXdhh+Ui0lshVnyE1gCpiIYkwO/VPB9phfPjqYBIfxK+vJyfTox+mxyejOI5/ZxFbFSG6m6aUNUWvFbL9Lk32TfiEyQCvdfll6lvMhMXU35X2szn6VBwTuzD43BU6E7Omtbmn+Ya2TI4aqtPvFw/9O/S6UFIovGsb8t1hHN+dEEkVsaP4eLcxn6sFlyILc9q1vkf14uu1ZbRW7ynXffa+Zr+rvqiJwj4bKNtfr5V0mJZW+HWYxlYH3IiDen96c0ujSoE+180oF8Y3n7MpGz+Y6hzaRTvSBd93bclxlSV6NdIGFZUqyRNHJXnMjRgvqNI+RHBjnkGN5cHzAM7zuVDzp1G3W8NckfNq/wzMs20LRvyC1Bca6/epmnkyRx76eUXfMx3AjU8uDCqqOMGji8lOf/iAMtUF0lDuc4SW/O8//wqIdvYOAfcCLkoLRi/R0uDIVQYziStBF4Xde4VDXkh0Tq5BKI9zS1NAJubCcxm6EM32KTc8EVJQiBKZJrSFXpS7EXzI0edoaes7S/eUDBcoKbJBan0f7g4aeOl1EXg0MsNS2/sZiRQBh6R0QqFz4BBbCKqcqxSh9UUE2tJdBpVHa6xwCFwURDzTFnA2E6mggykfLU89FFzxORKzCEhuskJ3KbI6KZ0Hp2UZFCGOBaKvVVSImRvBT2KBteK0mKHnQmIG85KOiCDVGUKTnqSGyiBB58EQe5FiONR5bj1IXKANsRc8OSulBKOpbggu6VbW9y0d5C1XjkpmLVDrms58xmq6IwQeGV+P4KP6qK4oWEqHFABSqHs3/agO4KYLsw+YOOHx9vs2H5bL5U4evBxizoTPywQsGr3FzcNiyJo+vPt4SU1mmDDDyLY4Q0vaBBvNUWGIQG5EXdng5vTyPJRYyFGaLWeC7KYurY6JcHyFnu6lbtziX1IRpJjgaajRzQxJmfv24TmhXqIt3MXsii7MaTtjP2KqcSAes4hJkaJy2KvDp2eX72EBr0Yxi3pV6AuMN35//uO7X6/ekTRUWGuLTUbxKA6zrHa+4KrHavCQ0BTlgbk32yb1P315aMqxx5UfG8lFaH3NIFK3rRs2aFu3Ecu187S+2STc4W9WVhUt1/d/amaZcKTt9gXgHte994owtdfDy6O0zcPClvSWPqwg2tBlo7Y/EMMac5qmaPoMdsaKQW8+e3fNIsZLnw/70n3oS80POr3dUuve2cOGVQtAf0mnzwI2m7rnVVVHX289imgUbKnJN7dVVf0DL+uhcw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,b={},y=[];function I(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,s.jsx)(o(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,s.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{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"}}},title:"inline_response_200_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,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(I,{...e})}):I(e)}}}]);