OpenSign/assets/js/02fcf422.9b8fc054.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9490],{68362:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>f,default:()=>g,frontMatter:()=>h,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/v1/getdocumentlist.api.mdx","sourceDirName":"API-docs/v1","slug":"/API-docs/v1/getdocumentlist","permalink":"/docs/API-docs/v1/getdocumentlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar_label":"Get Document list from status","hide_title":true,"hide_table_of_contents":true,"api":"eJztWM1uGzkSfpUa5rCJ0ZbatpzM6jTGjNfr3WASxA4CrC0I7O6SmjGb7CHZ+oHQwB72DeYN5tHmSRbF/pUtO1ZmkNNcbDVZVayfj8Wq2jDH55aNb9hPOi4yVM6yScAStLERuRNasTF78eIFNNtwvc7Rjm/VB3RG4AKBgxTWgZ5B0oiAiFtMQCtw6xxv1a06GsDBwU+Gz1wryY4PDm4VAMBhtwYu5Q64QYgLY1A5uQahIPGc1nFX2AHJOyZ5l+rwvdFzg9Z+ldS8ZvYST0jijzrLJTpMniMv5QuECFGBLeIYrZ0VUq4hbmUshUuBSwkGfymEwQSsmCvuCoPVmSM683yV+73nnog1PVeJN0lpkFrN0QD3WohIopd+6n2OsRRqX4OShitag0sRCotmcKtYwHSOhhMuLhM2ZnN0TdAJBCxgOTc8Q4eGQLVhimfIxizRMSGBBUwQoHLuUnYfZdcperhsI8lpMDXSWMAaR7KxMwUGzLq1JPlWkM9ZwHCVS50gG8+4tEQQp5hxNt4wf/6YWWeEmhOlKjLCvYeWV6yBAwtYG8NKpD+S9K28wiZlGbS2SZEJ11j2S4FmvaVoo0it6UybrK9nbUerZsZXIiPNTsMwaJRWRRahYSXxcW/p+CjsqWDvRP6nafD4mWE5Ibk218qiJdrjMKR/24HsbgO0aPE+VQ6VI3qe51LEfmP42RLT5qECOvqMsYeUITFOVEcatIV0PTpuDCeDhcPMfpm/Wib0PsQEuYa7LZQ0trN/XIi745Mo/fgv8slM0OJ+ElLncjseDuuVwshBrDOS5oTbX5z1P+iqkAil3d4Sconcok9K7Y3zxmmZoPlWrqwwvJ+ESkPwrGXnQNZYMa1NKAOml2rLlmfJ/6x9IiR+8o7PZl8LOKN3x7Y7LUb9lCN2qoUZF/KL1BHiD/VCg7U81eoLx4xOXx8fnXz/5ojolyKZo/sD9le7+/nf4cpFeuX15XN8mJZ67O1KlxvLgK325DkejcqArffkekNHLfdkOvm+DFi6J9PoNWHZp9hn+Pxr7lTr87J/oxxmueQOp1fVPZg2eHiSyl9Kiyq5VO/Mdi6JtJbIVf9oeoHKgMUGucPkzD2NzuPw+OTwKDwM31wfvR6P/j4+fT0Iw/A/LGCrTHbWs4Q7ZP3kUH8XefJNzkHFI4nXunie+QYTYTB208LsvNhPxY6O41Lq5TTTiZjVb6t9+lxfF5DeTfDEzkzeR0hLCMKCVnINfMGFJDthmaLyxWKThImmjinMjM6AQyNh4BUunJ4azIR6DCHbdcUVOioHyV30v3IvkJSMOxFDI8oOoCb1FtKPRFhP7FLM4GWCM15IBxGmfCG0eTXY5ZZK3FSrGKdCTXFBddWOS7ut5M9+2dewfG0hQrekgrqn23UqbOe+qhJq/bflE6KyndFbWoZ0w+7hsPeE338Qt6+rUFTHTptSbnochtNRffFH4ehhSfcBc20cKO26gH/359V0aIze+UZ32NutwVNGjcLR9LQ16vShUZdqwaVI4Oz9JVzrO1Tf1qL+8a46/mFMRUXk99mWsf31ykiLcWGEW/vGa3XIc3FY7Y9vJlS5Z+hSXXdtvlNzKRuzYb+BG27qTq1kJM8smj7O56S2grVcJZFeDXSOiuojySNL9cWQ52K4oLLhPgfP8z2osTjcj8E6Phdq/jTXpHPRFYWxitSWo7oaJxf/Ripy6jj0qepGK0XuS8ySvmfaM9fReZejopfQx3Zx9CBJfEIZ68xnJkqYDfnv//vNczQR8dD7jlr5d4WBXC/RUFNFjf9M4ooafU+Pmd+zsNYFybTIM4nW+imHw7nhDiERc+G49NW+UHOIec4jIQUhlsg0cRvogd4O4FOKLkVDW38zNOpJcIGSgN7mXTXvEv5Sm7uZ1EsbAIeosELRaAZVylVMhI37A9AGuAJUDk1uBDUhzpDWotJNK2d47CDjis+RZAdbXkpQCsImGB0V1oHVsvAqg+NCahqPNAYpxKSatpxTx2sQaJUafIMpIWWBMC9EgjaAWCcIVV9FJqgEIrQOctJFxOinEYWSOr7zcaN5D+Sa8oXgknJ+X0did4YrSw93pUsTg9ZhudHUKtfjoIODjxYpwm+FuqvmNIdw04LpE0ZWOJy8bFC/XC4foP3VNs+FcP8sIqDsaYXTZt1xz4VLi8jfkL6Q9qOSdIEKPX56N6CTkejYPrxwtDpMUebDK3SEEDs8e3/pU+wr+P2/v8Jb5EZBqpcVWuPCoFzDvDmKPFdFvnJbmyFhpj3wUvJ4XIGP5hxona3GU/du8/a1MzhDQ873geyOy0Ut/qZRE0j7P2Im5WpCMY/9U1J3a5RWfrgvx6d1NJl9N7tCsxBxMyt4JMJDTzxkAZMiRmWx91ycXbx/Cws4GYQs6KXIZ0R7+Pbyx/Ofr85JG7pZlceOBuEg9F2Yti7jqnfUBXaj3GoC7Gu8akZ7P+Ntunf1r2nyX9Pkdppcv7bUeg5zyYWvcer+p6pPbti9AfO4mSVPApZq64hksyGIfDSyLGm5GoFS2VLX/d0Q9A7XvZHtgsuibp8epa1nqx3phD6MINrdZzyK/Jcf6si9gucMu3c6p6lP1LqvVKNs45tyQiOGqkAhHavdszjGvG/3gwp3q0y8OL9mvktLtwujO18Y1T9I+k6dtiumSgH6S67eybDZVEVXWbb01dajHLWBDTU5aFKW5f8ByAlIbA==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/v1/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/v1/resendrequestmail"}}');var i=n(74848),o=n(28453),r=n(33617),a=n.n(r),l=n(17543),p=n.n(l),m=n(86013),c=n.n(m),d=n(63723),u=n.n(d),x=(n(18766),n(79329),n(9303));const h={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWM1uGzkSfpUa5rCJ0ZbatpzM6jTGjNfr3WASxA4CrC0I7O6SmjGb7CHZ+oHQwB72DeYN5tHmSRbF/pUtO1ZmkNNcbDVZVayfj8Wq2jDH55aNb9hPOi4yVM6yScAStLERuRNasTF78eIFNNtwvc7Rjm/VB3RG4AKBgxTWgZ5B0oiAiFtMQCtw6xxv1a06GsDBwU+Gz1wryY4PDm4VAMBhtwYu5Q64QYgLY1A5uQahIPGc1nFX2AHJOyZ5l+rwvdFzg9Z+ldS8ZvYST0jijzrLJTpMniMv5QuECFGBLeIYrZ0VUq4hbmUshUuBSwkGfymEwQSsmCvuCoPVmSM683yV+73nnog1PVeJN0lpkFrN0QD3WohIopd+6n2OsRRqX4OShitag0sRCotmcKtYwHSOhhMuLhM2ZnN0TdAJBCxgOTc8Q4eGQLVhimfIxizRMSGBBUwQoHLuUnYfZdcperhsI8lpMDXSWMAaR7KxMwUGzLq1JPlWkM9ZwHCVS50gG8+4tEQQp5hxNt4wf/6YWWeEmhOlKjLCvYeWV6yBAwtYG8NKpD+S9K28wiZlGbS2SZEJ11j2S4FmvaVoo0it6UybrK9nbUerZsZXIiPNTsMwaJRWRRahYSXxcW/p+CjsqWDvRP6nafD4mWE5Ibk218qiJdrjMKR/24HsbgO0aPE+VQ6VI3qe51LEfmP42RLT5qECOvqMsYeUITFOVEcatIV0PTpuDCeDhcPMfpm/Wib0PsQEuYa7LZQ0trN/XIi745Mo/fgv8slM0OJ+ElLncjseDuuVwshBrDOS5oTbX5z1P+iqkAil3d4Sconcok9K7Y3zxmmZoPlWrqwwvJ+ESkPwrGXnQNZYMa1NKAOml2rLlmfJ/6x9IiR+8o7PZl8LOKN3x7Y7LUb9lCN2qoUZF/KL1BHiD/VCg7U81eoLx4xOXx8fnXz/5ojolyKZo/sD9le7+/nf4cpFeuX15XN8mJZ67O1KlxvLgK325DkejcqArffkekNHLfdkOvm+DFi6J9PoNWHZp9hn+Pxr7lTr87J/oxxmueQOp1fVPZg2eHiSyl9Kiyq5VO/Mdi6JtJbIVf9oeoHKgMUGucPkzD2NzuPw+OTwKDwM31wfvR6P/j4+fT0Iw/A/LGCrTHbWs4Q7ZP3kUH8XefJNzkHFI4nXunie+QYTYTB208LsvNhPxY6O41Lq5TTTiZjVb6t9+lxfF5DeTfDEzkzeR0hLCMKCVnINfMGFJDthmaLyxWKThImmjinMjM6AQyNh4BUunJ4azIR6DCHbdcUVOioHyV30v3IvkJSMOxFDI8oOoCb1FtKPRFhP7FLM4GWCM15IBxGmfCG0eTXY5ZZK3FSrGKdCTXFBddWOS7ut5M9+2dewfG0hQrekgrqn23UqbOe+qhJq/bflE6KyndFbWoZ0w+7hsPeE338Qt6+rUFTHTptSbnochtNRffFH4ehhSfcBc20cKO26gH/359V0aIze+UZ32NutwVNGjcLR9LQ16vShUZdqwaVI4Oz9JVzrO1Tf1qL+8a46/mFMRUXk99mWsf31ykiLcWGEW/vGa3XIc3FY7Y9vJlS5Z+hSXXdtvlNzKRuzYb+BG27qTq1kJM8smj7O56S2grVcJZFeDXSOiuojySNL9cWQ52K4oLLhPgfP8z2osTjcj8E6Phdq/jTXpHPRFYWxitSWo7oaJxf/Ripy6jj0qepGK0XuS8ySvmfaM9fReZejopfQx3Zx9CBJfEIZ68xnJkqYDfnv//vNczQR8dD7jlr5d4WBXC/RUFNFjf9M4ooafU+Pmd+zsNYFybTIM4nW+imHw7nhDiERc+G49NW+UHOIec4jIQUhlsg0cRvogd4O4FOKLkVDW38zNOpJcIGSgN7mXTXvEv5Sm7uZ1EsbAIeosELRaAZVylVMhI37A9AGuAJUDk1uBDUhzpDWotJNK2d47CDjis+RZAdbXkpQCsImGB0V1oHVsvAqg+NCahqPNAYpxKSatpxTx2sQaJUafIMpIWWBMC9EgjaAWCcIVV9FJqgEIrQOctJFxOinEYWSOr7zcaN5D+Sa8oXgknJ+X0did4YrSw93pUsTg9ZhudHUKtfjoIODjxYpwm+FuqvmNIdw04LpE0ZWOJy8bFC/XC4foP3VNs+FcP8sIqDsaYXTZt1xz4VLi8jfkL6Q9qOSdIEKPX56N6CTkejYPrxwtDpMUebDK3SEEDs8e3/pU+wr+P2/v8Jb5EZBqpcVWuPCoFzDvDmKPFdFvnJbmyFhpj3wUvJ4XIGP5hxona3GU/du8/a1MzhDQ873geyOy0Ut/qZRE0j7P2Im5WpCMY/9U1J3a5RWfrgvx6d1NJl9N7tCsxBxMyt4JMJDTzxkAZMiRmWx91ycXbx/Cws4GYQs6KXIZ0R7+Pbyx/Ofr85JG7pZlceOBuEg9F2Yti7jqnfUBXaj3GoC7Gu8akZ7P+Ntunf1r2nyX9Pkdppcv7bUeg5zyYWvcer+p6pPbti9AfO4mSVPApZq64hksyGIfDSyLGm5GoFS2VLX/d0Q9A7XvZHtgsuibp8epa1nqx3phD6MINrdZzyK/Jcf6si9gucMu3c6p6lP1LqvVKNs45tyQiOGqkAhHavdszjGvG/3gwp3q0y8OL9mvktLtwujO18Y1T9I+k6dtiumSgH6S67eybDZVEVXWbb01dajHLWBDTU5aFKW5f8ByAlIbA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1/opensign-api-v-1",custom_edit_url:null},f=void 0,y={},b=[{value:"Document Types:",id:"document-types",level:3}];function j(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,i.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(p(),{parameters:[{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}},{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)(c(),{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:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},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},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:0}},xml:{name:"document"},title:"document"}}},title:"inline_response_200_4"}}}},404:{description:"Report not available!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Report not available!"}},title:"inline_response_404_5"}}}},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 g(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]);