Files
OpenSign/assets/js/74c638d3.95f1a2ef.js
T

1 line
12 KiB
JavaScript

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1335],{51412(e,t,a){a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>x,default:()=>k,frontMatter:()=>g,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"id":"API-docs/v1.2/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/v1.2/gettemplatelist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/gettemplatelist","permalink":"/docs/API-docs/v1.2/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":"eJzdWc2OG7kRfpUKD4nd6JE045/daC9rZA17kMHayIxhJDMDgd1draaHTXJJtn4yELCHvEFOuebR/CRBkd2t1ki2vJtFNokPY4msIuufX5Xumedzx6bX7AprI7lHx25TVqDLrTBeaMWm7KpCeIUeOhK4EM7Di7fnwKXUSwdr3YDXYNFbgQsEDpIodAl8wYXkmUTw3fkjuKqEg7JROZ3PpfBrMFYvRIEOuAK9QLsQuAz8Um45U0DFMynUHBqH1tGdeaW1QyitrgFXwnna7TlgWaGC3CIP64XOmxqVdyOWMm3QcpLgvGBTNkffcZHsLGWGW16jR0vmuWeK18imTIpa0K4gw/zQoF2zlFn8oREWCzYtuXSYMufXkqhLbWuWMlwZqQtkU28b2s0rrDmb3rOar0Td1Gz6bDJJmV8bYlJNnaFlG+LjtaGDTiebtBfB3Qnzi0nw6Tsnm1s61xmtHDqiPZtM6L/d4HBNnqNzZSOhtyhLWa6VR+WJnhsjRR42xh8cMd3vC6CzD5gHs1s6xot4pUXXSD+g49ZyUlh4rN1x/rhMHu4pnbdCzVkaTMP9cKXXna1OX2eqdmdv52QTLzyt7h+xZXDhQx95xKW0P8LUUUMg3aSsFMfuqbw3bjoed6yUCKNc18StlwrtF94YckJbCDG1SZkTcxVC/eda2upjoueog1lCFH+O8INGyDCIhTUX8ih1hvhtu9DZwlRaHbnm6bPnZ6dPvv7qlG02GzIBquJcvbHFjhEzrSVyNeSkHGrpZ0LNNHHM6ILcf54x5OYmZaFsznRZSqFwRqY/yLebaO8r9BVaaD0FOVfgmqwWHjjk2qypXnoqrb2TA2kBjaPixxXgyqNVXILXWkKpLYSQAYtUb0fwHZa8kT4U1iDr6JD0IXSweOE/b96zydmTk9PJyeSrq9Pn06e/nz57PppMJn9hKVvVwadtPSvafGmzrP/emOI/ck94VPBKN1/mdouFsJj7WWMPRubnygrrnV/rQpRtVXRfGDWN1zOLtVBHI7RjidQzrXKkSMUFvRZ7VX+n6FNeYymkPJTyuxH5Z92EKGwfb1iKYo6eHl2RV2EH6wwLyLDUFoHyJbzOuo3hvRrSHvDzi1Dc/Wk+8bjymV6FosHneMg8+3CIKCHug1atxr7qbACu0o0sgBuD3I4IroBuLFwnyXeYNXN4d54kt4+6Ys6NGWmDiswieeaoiI0LIjRF+TjAHC7zJuQ0XbLgsgm52eu178nTTcpWx5VZQa5PtC2EosMfSSw9NMaghVxbhfZxhFZRwf8e5SYUqAdDeVe99f+kek9Iu+Vx7d6LwldU9qPkv4qsT0nW6risr1HMK/8rC/s1CavNw6L7iWpyHKkMakeHlI+CFSLOtdRHkBqBeUKEWnkn/nqwLG3T4WwT/20ft66I09ruMziEqB31dm14hlABn3Sazc4mk9nzFiw9nTzb7wXO1YJLUYTW8ErfofrNL9cJoLXHTDa83sfr99UXkSjssx1lh+sdIswbK/w6NICrE27ESdyfXt9Sd1Sjr3TbPYaO0VdsysYPGkmHdtF1kQEz9CDecVVkerUf5tyI8eJ0dMao7dvlOZgWn6HH5uSnsjjP50LNj/Hdbg10SU6Mftox0/YdN+KPSA9564UhVdvKVsgJ15DdhSp1YG5988aguhRzFTwbLt+rhChzXSNVBaoFSdKxfPzbP3uuJOknACEGRzfqRr1pLBi9REsdLFcFlBJXgiYWxIZ12OtHHA55LdE5uQahPM4tVZ9CzIXnMqAaAjg5NzwTUlDoEpkmbguD6Hcj6OD8Wje/szQyKXCBkiIeCOjVuxMLWGp7V9KwJQUOGSF6dA5QVVzlRNh5IgVtA9RXHq2xwiE4b0lqEWXTyluee6i54nOks1MYGqtAKShcweqscR6clk0QGTwXUlssoFNIIRYuGPEljRdsLOe5ro3FisJmgTBvaKyTQq4LhNgkkwqKUKHzYEgWkWNoORoldX4XHFg2UoLRVDgEl/RqDGUkdm+5clTqoyydD3qDGatpLoFRwCR555A8fCHUnZsmyY06ges+rt5j5oTH7eOzXC73Qv/xLs8r4V83GfwJjXbCa7vecs+Fr5ospMvwkP5LPOkVKgzxM0iG7RmFzt2B90/nblyhNONL9BQhbvzi7XmotY/h449/hwvkVkGllzFa88aiXMO8u4osFz0fzdaXytAN8sZXZPE8Bh8NldD5zoLvK+4//vgPB9/jEoRqU4pUSZKd8eBv96eFSTIFi7VeUDuqFJJruF3DdsgWRHNICx4LaN8vKLjnEaPFnmHAMaKrb8LMZGa4c0ttixu2JQBeFFiQpLFj7fviFGJrOVhoKbbpJnw12C4sL/12N4oqyyATWN34GMBdI9RJE4xqrPaYB52KshN6fwLwRZKHmx8IP7g/nLqdjcbGlgpCIVz8GC/sKxXJ5ysUdjCejQJGa89oqnNYMsrSbhQRn2zK0l1D7dn1qKH3PEUKmyaTIn+o8Ahe5DkaMmyAfm4KSRIlShJ4VMRZxuMUkoSmG7RKn7khL9G3EVy28tdU6CpOk2sPEjnNrlsrcd/Yrqv7BuJBQwalu7b3G+iOdlDzdXueWm/bYuEr3dC0ZntwO7clU4xu6Cl88HzuvnIWS7Rku+DebVIb0SbxdVcMgGrEv1NMIkpVnseZVjuHo3f824fnBBSFtnZvykua3OfdnPITdXQciMcsZVLk2ELmFhe8ePX2AhZPRhOWDkDJF5TU8cX5H15+f/mShCEXRIOdjiajSejstfM1V4ObdkpUi9R2rH2/Ra7/p7+AtNiMmpixkVwEPNxOtSKWvWY7WPY2ZZV2ntbv7zPu8J2Vmw0tx98hCOG2pWb7S8Qdrge/m4RUjZOwT9K2P3BsSW/pixVEG6B32oFFujDyxFow4NrrNXYA+6uXVyxM1KpdkHoXQGr7gU7vttR6cPYueo0C0F/S6SDD/X0EwJtNTx+3PsnRKthRk29uN5vNvwBft7Dx","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/v1.2/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.2/get-webhook"}}');var n=a(74848),o=a(28453),r=a(57742),i=a.n(r),l=a(78178),p=a.n(l),d=a(19624),m=a.n(d),u=a(96226),c=a.n(u),b=(a(77675),a(19365),a(51107)),h=a(21312);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:"eJzdWc2OG7kRfpUKD4nd6JE045/daC9rZA17kMHayIxhJDMDgd1draaHTXJJtn4yELCHvEFOuebR/CRBkd2t1ki2vJtFNokPY4msIuufX5Xumedzx6bX7AprI7lHx25TVqDLrTBeaMWm7KpCeIUeOhK4EM7Di7fnwKXUSwdr3YDXYNFbgQsEDpIodAl8wYXkmUTw3fkjuKqEg7JROZ3PpfBrMFYvRIEOuAK9QLsQuAz8Um45U0DFMynUHBqH1tGdeaW1QyitrgFXwnna7TlgWaGC3CIP64XOmxqVdyOWMm3QcpLgvGBTNkffcZHsLGWGW16jR0vmuWeK18imTIpa0K4gw/zQoF2zlFn8oREWCzYtuXSYMufXkqhLbWuWMlwZqQtkU28b2s0rrDmb3rOar0Td1Gz6bDJJmV8bYlJNnaFlG+LjtaGDTiebtBfB3Qnzi0nw6Tsnm1s61xmtHDqiPZtM6L/d4HBNnqNzZSOhtyhLWa6VR+WJnhsjRR42xh8cMd3vC6CzD5gHs1s6xot4pUXXSD+g49ZyUlh4rN1x/rhMHu4pnbdCzVkaTMP9cKXXna1OX2eqdmdv52QTLzyt7h+xZXDhQx95xKW0P8LUUUMg3aSsFMfuqbw3bjoed6yUCKNc18StlwrtF94YckJbCDG1SZkTcxVC/eda2upjoueog1lCFH+O8INGyDCIhTUX8ih1hvhtu9DZwlRaHbnm6bPnZ6dPvv7qlG02GzIBquJcvbHFjhEzrSVyNeSkHGrpZ0LNNHHM6ILcf54x5OYmZaFsznRZSqFwRqY/yLebaO8r9BVaaD0FOVfgmqwWHjjk2qypXnoqrb2TA2kBjaPixxXgyqNVXILXWkKpLYSQAYtUb0fwHZa8kT4U1iDr6JD0IXSweOE/b96zydmTk9PJyeSrq9Pn06e/nz57PppMJn9hKVvVwadtPSvafGmzrP/emOI/ck94VPBKN1/mdouFsJj7WWMPRubnygrrnV/rQpRtVXRfGDWN1zOLtVBHI7RjidQzrXKkSMUFvRZ7VX+n6FNeYymkPJTyuxH5Z92EKGwfb1iKYo6eHl2RV2EH6wwLyLDUFoHyJbzOuo3hvRrSHvDzi1Dc/Wk+8bjymV6FosHneMg8+3CIKCHug1atxr7qbACu0o0sgBuD3I4IroBuLFwnyXeYNXN4d54kt4+6Ys6NGWmDiswieeaoiI0LIjRF+TjAHC7zJuQ0XbLgsgm52eu178nTTcpWx5VZQa5PtC2EosMfSSw9NMaghVxbhfZxhFZRwf8e5SYUqAdDeVe99f+kek9Iu+Vx7d6LwldU9qPkv4qsT0nW6risr1HMK/8rC/s1CavNw6L7iWpyHKkMakeHlI+CFSLOtdRHkBqBeUKEWnkn/nqwLG3T4WwT/20ft66I09ruMziEqB31dm14hlABn3Sazc4mk9nzFiw9nTzb7wXO1YJLUYTW8ErfofrNL9cJoLXHTDa83sfr99UXkSjssx1lh+sdIswbK/w6NICrE27ESdyfXt9Sd1Sjr3TbPYaO0VdsysYPGkmHdtF1kQEz9CDecVVkerUf5tyI8eJ0dMao7dvlOZgWn6HH5uSnsjjP50LNj/Hdbg10SU6Mftox0/YdN+KPSA9564UhVdvKVsgJ15DdhSp1YG5988aguhRzFTwbLt+rhChzXSNVBaoFSdKxfPzbP3uuJOknACEGRzfqRr1pLBi9REsdLFcFlBJXgiYWxIZ12OtHHA55LdE5uQahPM4tVZ9CzIXnMqAaAjg5NzwTUlDoEpkmbguD6Hcj6OD8Wje/szQyKXCBkiIeCOjVuxMLWGp7V9KwJQUOGSF6dA5QVVzlRNh5IgVtA9RXHq2xwiE4b0lqEWXTyluee6i54nOks1MYGqtAKShcweqscR6clk0QGTwXUlssoFNIIRYuGPEljRdsLOe5ro3FisJmgTBvaKyTQq4LhNgkkwqKUKHzYEgWkWNoORoldX4XHFg2UoLRVDgEl/RqDGUkdm+5clTqoyydD3qDGatpLoFRwCR555A8fCHUnZsmyY06ges+rt5j5oTH7eOzXC73Qv/xLs8r4V83GfwJjXbCa7vecs+Fr5ospMvwkP5LPOkVKgzxM0iG7RmFzt2B90/nblyhNONL9BQhbvzi7XmotY/h449/hwvkVkGllzFa88aiXMO8u4osFz0fzdaXytAN8sZXZPE8Bh8NldD5zoLvK+4//vgPB9/jEoRqU4pUSZKd8eBv96eFSTIFi7VeUDuqFJJruF3DdsgWRHNICx4LaN8vKLjnEaPFnmHAMaKrb8LMZGa4c0ttixu2JQBeFFiQpLFj7fviFGJrOVhoKbbpJnw12C4sL/12N4oqyyATWN34GMBdI9RJE4xqrPaYB52KshN6fwLwRZKHmx8IP7g/nLqdjcbGlgpCIVz8GC/sKxXJ5ysUdjCejQJGa89oqnNYMsrSbhQRn2zK0l1D7dn1qKH3PEUKmyaTIn+o8Ahe5DkaMmyAfm4KSRIlShJ4VMRZxuMUkoSmG7RKn7khL9G3EVy28tdU6CpOk2sPEjnNrlsrcd/Yrqv7BuJBQwalu7b3G+iOdlDzdXueWm/bYuEr3dC0ZntwO7clU4xu6Cl88HzuvnIWS7Rku+DebVIb0SbxdVcMgGrEv1NMIkpVnseZVjuHo3f824fnBBSFtnZvykua3OfdnPITdXQciMcsZVLk2ELmFhe8ePX2AhZPRhOWDkDJF5TU8cX5H15+f/mShCEXRIOdjiajSejstfM1V4ObdkpUi9R2rH2/Ra7/p7+AtNiMmpixkVwEPNxOtSKWvWY7WPY2ZZV2ntbv7zPu8J2Vmw0tx98hCOG2pWb7S8Qdrge/m4RUjZOwT9K2P3BsSW/pixVEG6B32oFFujDyxFow4NrrNXYA+6uXVyxM1KpdkHoXQGr7gU7vttR6cPYueo0C0F/S6SDD/X0EwJtNTx+3PsnRKthRk29uN5vNvwBft7Dx",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},x=void 0,f={},y=[];function w(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,n.jsx)(i(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,n.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,n.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(h.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(p(),{...a(57373)}),"\n",(0,n.jsx)(m(),{...a(28527)}),"\n",(0,n.jsx)(c(),{...a(5185)})]})}function k(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(w,{...e})}):w(e)}},57373(e){e.exports=JSON.parse('{"parameters":[{"name":"limit","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":500,"type":"number"},"example":10},{"name":"skip","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"},"example":0}]}')},28527(e){e.exports={title:"Body"}},5185(e){e.exports=JSON.parse('{"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"},"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"}}}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this template signed using an external tool for owner review. Defaults to false.","example":false},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0},"prefill":{"type":"object","description":"You can provide widgets which can embed before sending to signer","properties":{"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","description":"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":1},"x":{"type":"number","description":"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":100},"y":{"type":"number","description":"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":30},"w":{"type":"number","description":"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":40},"h":{"type":"number","description":"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.","format":"number","example":80},"options":{"type":"object","properties":{"name":{"type":"string","example":"textbox"},"response":{"type":"string","example":"joe"},"color":{"type":"string","example":"red"},"fontsize":{"type":"number","example":12}}}}}}},"title":"prefill"}},"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"}}}}}}')}}]);