mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-22 09:34:54 +02:00
1 line
9.4 KiB
JavaScript
1 line
9.4 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:()=>h,default:()=>v,frontMatter:()=>y,metadata:()=>l,toc:()=>g});const l=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":"eJzdWN1u2zYUfhWWN1sDxVZ+2/mqwRCkwYIlWFIUWGoYFHVssaFIjqT8A0PALvYGe4M9Wp9kOJRkS3ESJ2vRi90kFnk+nl+eHy6pZxNHB7f0BnIjmQdHhxFNwXErjBda0QG9yYCcgScNCbkQzpOTq3PCpNQzRxa6IF4TC94KmAJhRCKFHhM2ZUKyRALxzfk9cpMJR8aF4ng+k8IviLF6KlJwhCmip2CnAmYBL+UaGRFQLJFCTUjhwDrkyTOtHZCx1TmBuXAed1cIMstAEW6BhfVU8yIH5V2PRlQbsAwlOE/pgE7ANyiUnUbUMMty8GDRPEuqWA50QKXIBe4KNMwfBdgFjaiFPwphIaWDMZMOIur8QiL1WNucRhTmRuoU6MDbAnd5BjmjgyXN2VzkRU4HR3EcUb8wCFJFnoClJeJYbvCgvbiMViK4O2G+mQSP84zLIZ7rjFYOHNLuxzH+6waHKzgH58aFJCuL0ohyrTwoj/TMGCl42Oh/dghabgqgk8/Ag9ktHuNFxdKCK6Rv0TFrGSosPORuO75aRg+vKJ23Qk1oFEzDfHtlpTud771PVO72ryZoEy88rm4esQa48GMVeYhS2m8BNdQkkJYokkzBfi+1qnh6SsBKHhIIy7UhVoKPaoFRdLHNRJn3xg36/QaMd7jHdY5oPVMdvZ8yVrjOupEqok5MVLil/zVIrN4mOgf9PIN91kASCGJBzoTcSp0AvKsXGluYTKstbA6Pjvf3Dt6+2UP6mUgn4L9C/2r3ZZHkYe4TPQ/ysglsppIWfLWyzmdlROcvxOwfHpYRXbwQ9QZZzV4IOnhbRjR7IejwGOM4pMVn2PyxUHqWzcsH7+J1dQ9GTTw8SRWuswOVnqtL2805idYSmGqzxqpRRjTcPEhP/NPRuR/vH+zuxbvxm5u948HhT4Oj414cx7/TiM5zudaepnWmbIRsvguTfhc+oZ2AG108T30LqbDA/aiwD17sp3yH7EK3NMp1KsZ1PXRP8w21HIGF1yMLuVBbPdVAKuqRVhxGQo1gin3CAwHdKvflfbO1i9n9OOpGl1BSKBg13cJoP45Hx3WcHsZHm13DuZoyKdLQRN7oO1Cvvl3PANbqLbWkzd5X7DfVFxVR2KcdZdvrlZIOeGGFX4RWcb7LjNit9ge3Q+yjcvCZrvvM0Fv6jA5o/17L6cBOm34zxNiqZjqm0kTPe9qAwnonWeKwXvSZEf0ploH7CGbMC6ih2H0ZwHk2EWryNGq4Nsw1Oq/yT8c865plxC+ARau2fpuqbnYzYKHZKPF7rAO49smlAYWZLXh0ukfvjzAfQXKdA04MPgPSkH/565+AaAaDEHCvPqlP6rKwxOgZWGxsmUrJWMJc4CCD9JCHvdXk44DlEpyTCyKUh4nFPiUVE+GZJGganD44MywRUmCcIplGtCWtUHc98jEDn4HFrR8sTlIpTEFieBPMAnl3kCEzbe/GOINFhJGkcEKBcwRUxhRHwsb8EdEWZytQHqyxwgFx3qLUopJNK28Z9yRnik0Az446VkpBCoxNYnVSOE+clkUQmXgmpLaQkkYhBZC6HhrxFKcOCwRXuc6NhQwjZQpkUuC0FxGuUyBV74wqqJQk4DwxKIvgEEa8QknN74LfxoWUxGjMEoJJHBDbMiLcW6YcJuJKlsYHK4MZq3FcgUrAnZ0PDtDDF0LducHOzie1S25XwfQREic8DH9son42m21E++su5kz490VCfgOjnfDaLtboifBZkYQb0j5k9VGddAYKQvy0bsD6jFRzt3nhcLWfgTT9a/AYIa5/cnUeEutr8uXPv8kFMKtIpmdVtPLCglyQScMKLVd5vjLbKi+SsQ6Bl6HFeRV8OGuC82hBrLTd29y9dhbGYNH4wZFrdkbUx982YhKU/mvUxAyNUcx4KCB1941p5d39c0IyB5u7y/E1PjXwZjp5xMP9QNynEZWCg3LQKhInZ1cXZEoOejGNWinyGd7uX5z/fPrr9SlKgzerstheL+7FoavWzudMtVh1nmDqitEx93JdQf+nbzZ1rcBGuG8kE6Eu191YVVNvaaemDiOaaedxfblMmIMPVpYlLlcvJ1hpU+FQ2/XbyR0sWi89UyaLuoN7lLZ+klmTDvHDCqQNLUDUFC9kWGFOOAfTZrDR83Qah7PTGxo6waxbNO9C0ax/4OnNllq0zu5W00oA/Is6PQhYLquCXJYr+mrrUUStYEONvhmWZfkvKOUVLA==","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 i=a(74848),n=a(28453),s=a(33617),o=a.n(s),p=a(17543),r=a.n(p),m=a(86013),d=a.n(m),c=a(63723),u=a.n(c),x=(a(18766),a(79329),a(9303));const y={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:"eJzdWN1u2zYUfhWWN1sDxVZ+2/mqwRCkwYIlWFIUWGoYFHVssaFIjqT8A0PALvYGe4M9Wp9kOJRkS3ESJ2vRi90kFnk+nl+eHy6pZxNHB7f0BnIjmQdHhxFNwXErjBda0QG9yYCcgScNCbkQzpOTq3PCpNQzRxa6IF4TC94KmAJhRCKFHhM2ZUKyRALxzfk9cpMJR8aF4ng+k8IviLF6KlJwhCmip2CnAmYBL+UaGRFQLJFCTUjhwDrkyTOtHZCx1TmBuXAed1cIMstAEW6BhfVU8yIH5V2PRlQbsAwlOE/pgE7ANyiUnUbUMMty8GDRPEuqWA50QKXIBe4KNMwfBdgFjaiFPwphIaWDMZMOIur8QiL1WNucRhTmRuoU6MDbAnd5BjmjgyXN2VzkRU4HR3EcUb8wCFJFnoClJeJYbvCgvbiMViK4O2G+mQSP84zLIZ7rjFYOHNLuxzH+6waHKzgH58aFJCuL0ohyrTwoj/TMGCl42Oh/dghabgqgk8/Ag9ktHuNFxdKCK6Rv0TFrGSosPORuO75aRg+vKJ23Qk1oFEzDfHtlpTud771PVO72ryZoEy88rm4esQa48GMVeYhS2m8BNdQkkJYokkzBfi+1qnh6SsBKHhIIy7UhVoKPaoFRdLHNRJn3xg36/QaMd7jHdY5oPVMdvZ8yVrjOupEqok5MVLil/zVIrN4mOgf9PIN91kASCGJBzoTcSp0AvKsXGluYTKstbA6Pjvf3Dt6+2UP6mUgn4L9C/2r3ZZHkYe4TPQ/ysglsppIWfLWyzmdlROcvxOwfHpYRXbwQ9QZZzV4IOnhbRjR7IejwGOM4pMVn2PyxUHqWzcsH7+J1dQ9GTTw8SRWuswOVnqtL2805idYSmGqzxqpRRjTcPEhP/NPRuR/vH+zuxbvxm5u948HhT4Oj414cx7/TiM5zudaepnWmbIRsvguTfhc+oZ2AG108T30LqbDA/aiwD17sp3yH7EK3NMp1KsZ1PXRP8w21HIGF1yMLuVBbPdVAKuqRVhxGQo1gin3CAwHdKvflfbO1i9n9OOpGl1BSKBg13cJoP45Hx3WcHsZHm13DuZoyKdLQRN7oO1Cvvl3PANbqLbWkzd5X7DfVFxVR2KcdZdvrlZIOeGGFX4RWcb7LjNit9ge3Q+yjcvCZrvvM0Fv6jA5o/17L6cBOm34zxNiqZjqm0kTPe9qAwnonWeKwXvSZEf0ploH7CGbMC6ih2H0ZwHk2EWryNGq4Nsw1Oq/yT8c865plxC+ARau2fpuqbnYzYKHZKPF7rAO49smlAYWZLXh0ukfvjzAfQXKdA04MPgPSkH/565+AaAaDEHCvPqlP6rKwxOgZWGxsmUrJWMJc4CCD9JCHvdXk44DlEpyTCyKUh4nFPiUVE+GZJGganD44MywRUmCcIplGtCWtUHc98jEDn4HFrR8sTlIpTEFieBPMAnl3kCEzbe/GOINFhJGkcEKBcwRUxhRHwsb8EdEWZytQHqyxwgFx3qLUopJNK28Z9yRnik0Az446VkpBCoxNYnVSOE+clkUQmXgmpLaQkkYhBZC6HhrxFKcOCwRXuc6NhQwjZQpkUuC0FxGuUyBV74wqqJQk4DwxKIvgEEa8QknN74LfxoWUxGjMEoJJHBDbMiLcW6YcJuJKlsYHK4MZq3FcgUrAnZ0PDtDDF0LducHOzie1S25XwfQREic8DH9son42m21E++su5kz490VCfgOjnfDaLtboifBZkYQb0j5k9VGddAYKQvy0bsD6jFRzt3nhcLWfgTT9a/AYIa5/cnUeEutr8uXPv8kFMKtIpmdVtPLCglyQScMKLVd5vjLbKi+SsQ6Bl6HFeRV8OGuC82hBrLTd29y9dhbGYNH4wZFrdkbUx982YhKU/mvUxAyNUcx4KCB1941p5d39c0IyB5u7y/E1PjXwZjp5xMP9QNynEZWCg3LQKhInZ1cXZEoOejGNWinyGd7uX5z/fPrr9SlKgzerstheL+7FoavWzudMtVh1nmDqitEx93JdQf+nbzZ1rcBGuG8kE6Eu191YVVNvaaemDiOaaedxfblMmIMPVpYlLlcvJ1hpU+FQ2/XbyR0sWi89UyaLuoN7lLZ+klmTDvHDCqQNLUDUFC9kWGFOOAfTZrDR83Qah7PTGxo6waxbNO9C0ax/4OnNllq0zu5W00oA/Is6PQhYLquCXJYr+mrrUUStYEONvhmWZfkvKOUVLA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,b={},g=[];function f(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,i.jsx)(o(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,i.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,i.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{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,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.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",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},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},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},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"}}},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,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); |