Files
OpenSign/assets/js/58abd73c.cb327dba.js
T

1 line
8.2 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8564],{73135:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>P,contentTitle:()=>g,default:()=>I,frontMatter:()=>y,metadata:()=>r,toc:()=>b});const r=JSON.parse('{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/v1.1/folderlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/folderlist","permalink":"/docs/API-docs/v1.1/folderlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar_label":"Get folder list","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WF9vI7cR/ypTvrQR1pLsu0sQPdUIrq5b586oHRiIzzhwd0e7PHFJhpzVHwgC8tBvkKe85qPdJymG1EorW5ec2zQvlpecGf5m5jec2V0LklUQk3vxN6tL9OIhEyWGwitHyhoxEbc1QtqDKxUIzq8vARtnF+gDrGwLZMEjeYVzBAmaZewUpklloagGm35tS+CkR0PJ3mUpMmEdeslHXZZiIpIW2xCZcNLLBgk941sLIxsUE/HEgmKUP7ToV+Ixdpt/wIIuyz0gkQmPP7TKYykmU6kDZiLQSmM83DciE7h02pa43y5qbKSYrAWtHMsF8spUIosKkvoruJSNi8bEZpPtMGvVKHoM9bNxkG8PYDRyqZq2EZNX43HWgTJtk6MXmx6G03EPQpgp97sh+PSZ480D2w3OmoCBZc/GY/45TExoiwJDmLYadgQQmSisITTE8tI5rYq4MfoQWGn9FEDKL1PFsxlS6UiPodXUk5PeS3ZYETbht/U72jw3564+zevl2QfHIUl8exOj/zwzBhcdWzfZY74/09Y/zowMr2bqGh/b+m+RhTbvoSs8SsLynI6Z2iuejc9enJyOT8Zf3Z5+OXn59eTVl8PxePy9yMSy0ay7pWkpKSIlRbr/3LryDzint5BcfO8xiE1/XRmtDL7vKP7+bDx+f/qCZTaZeHmM6ze2QaqVqWCBhmDhrakycBplQCC/AllJZUBLQv+n368I0Hvrfz1az0P2a1F4yVHYBeHV0yBcmrnUqozd49bO0PyxnvaPp3Q8Qz3khEpCcV8cONtfT04GLFqvaBU70/JEOnWS9if3D3wFcmAtd7QKUyujWkzE6KC/BfTzrrk9osxCVhX6v7d5RHzekoVvbTFLbrVei4moiVyYjEZz5SlZGoakVrf5sLDN6NrLaav1GzmfST+yDs3odDgejgW3hUMjQZoyt8shCwVVGS3zEG1Ip0bz0+HpER3p3LPksT15rkogWSlT/Zbewz4fN8yZRIuDrOxbgVP/RO4F26T3pbbtsUYZb7cNP09tVN5S4a1Dc6MqE9MSD388ctyhLmyDPBVRjTAYdCof//3LTmswgNIWbYOGIuWH78w787b1EMcq7orSlDDVuFS5xqMjV0DZaAxBr0AZwspLQihVpUhq4DhxWRfSyVxpxZXCYpa1PfSKLQzhrkaq0fPWnz2PcCXOUXOBgWzJNpLYVIcXFtbPptouQgYS8jYogyEAmlqaggW7TGQ89kkDaAi98yogBPKMWiVs1pCXBUEjjayQbWfQD1aJWnF9gLd5GwiC1W2EDCSVth5L6BwyiGWIQXzNI4tH4NXCNs5jzbSZI1StKjFkUNgSIcSLgV0wJeQYCBxjUQUGNtoabYtZTCBXEDjL95SSmgfJPkZWJy9N4K6ZsHQ52AXMecuzDiaAg8F3ATnDV8rMwmQweGdO4H7HqzvMgyJ8+EtXAovF4gn1vzjUuVDEN8W/0NmgyPrVXrtS1N0GfSO7h2TpAg1G/vSKYW+jtEV4Wn28OqpRu9ENEjMkjM6vL+PV/gV8/PEnuELpDdR2kdhatB71CqruKI5cynwK2+5mhqmNxKs54kUiHw+qGKiL4F0t6eOPPwd4gwtQZltS7MpgcN3mWhVwi43jvhUGgwl8E4cUoG4NqJYEhTSQI4RaMpXmSoIEl7S1MrMhnJsVtKF7iWEy8HrUO3CD47JLd4BcBizBmqjRnTncI+L1JqCeY2BbxhLDwFIRM7r2tq3SaX0wW+c8TpXWcKfKCin6dl6W4LbLi7TMAe/BwSkXBNW4AukRAhoawvUjlbjTOmc9o1AJ/NRqbRecADSls8pQmEDp5ZT29rM90eMsqKw5spRCKHfhyLZmdilJlbj1eLc6fMeX8qOL/PC+9ThFzwdGt/d5cWpLp/uOlsBs/V9oHedda0gWcWTBRiqdOspfH9uJ4wP6Jryd3qCfqwK3Xe0TFT2KwiORCa0KNAF7Y8n5xfUVzF8Mxwet/zOKe3R1+c3rNzevGQxfpClg3QggnA3USNM76QKpe2/fjigHsV7vB7b/91eBbbMmXNLIaaniPBadX29nqfv+t4KHTNQ2EK+u11x/33m92fByetWNE5YKMte9l91P+nb0q8FRRDNcHfsiMZe6Td8AsiPnJqXuk8DnyG7f3feiD/zgFcvGgTPrZhZ2NOmcFwW6/gFPJuyDMfXi9a3IBF+7h7PSLM5K23/YerdlVj3bh0NUAsB/2aejCut1msM2m5182vqkxtbBTprj/7DZbP4DtcuImw==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/v1.1/deletefolder"},"next":{"title":"v1","permalink":"/docs/API-docs/v1"}}');var o=i(74848),s=i(28453),a=i(33617),n=i.n(a),l=i(17543),p=i.n(l),d=i(86013),c=i.n(d),m=i(63723),f=i.n(m),h=(i(18766),i(79329),i(9303));const y={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WF9vI7cR/ypTvrQR1pLsu0sQPdUIrq5b586oHRiIzzhwd0e7PHFJhpzVHwgC8tBvkKe85qPdJymG1EorW5ec2zQvlpecGf5m5jec2V0LklUQk3vxN6tL9OIhEyWGwitHyhoxEbc1QtqDKxUIzq8vARtnF+gDrGwLZMEjeYVzBAmaZewUpklloagGm35tS+CkR0PJ3mUpMmEdeslHXZZiIpIW2xCZcNLLBgk941sLIxsUE/HEgmKUP7ToV+Ixdpt/wIIuyz0gkQmPP7TKYykmU6kDZiLQSmM83DciE7h02pa43y5qbKSYrAWtHMsF8spUIosKkvoruJSNi8bEZpPtMGvVKHoM9bNxkG8PYDRyqZq2EZNX43HWgTJtk6MXmx6G03EPQpgp97sh+PSZ480D2w3OmoCBZc/GY/45TExoiwJDmLYadgQQmSisITTE8tI5rYq4MfoQWGn9FEDKL1PFsxlS6UiPodXUk5PeS3ZYETbht/U72jw3564+zevl2QfHIUl8exOj/zwzBhcdWzfZY74/09Y/zowMr2bqGh/b+m+RhTbvoSs8SsLynI6Z2iuejc9enJyOT8Zf3Z5+OXn59eTVl8PxePy9yMSy0ay7pWkpKSIlRbr/3LryDzint5BcfO8xiE1/XRmtDL7vKP7+bDx+f/qCZTaZeHmM6ze2QaqVqWCBhmDhrakycBplQCC/AllJZUBLQv+n368I0Hvrfz1az0P2a1F4yVHYBeHV0yBcmrnUqozd49bO0PyxnvaPp3Q8Qz3khEpCcV8cONtfT04GLFqvaBU70/JEOnWS9if3D3wFcmAtd7QKUyujWkzE6KC/BfTzrrk9osxCVhX6v7d5RHzekoVvbTFLbrVei4moiVyYjEZz5SlZGoakVrf5sLDN6NrLaav1GzmfST+yDs3odDgejgW3hUMjQZoyt8shCwVVGS3zEG1Ip0bz0+HpER3p3LPksT15rkogWSlT/Zbewz4fN8yZRIuDrOxbgVP/RO4F26T3pbbtsUYZb7cNP09tVN5S4a1Dc6MqE9MSD388ctyhLmyDPBVRjTAYdCof//3LTmswgNIWbYOGIuWH78w787b1EMcq7orSlDDVuFS5xqMjV0DZaAxBr0AZwspLQihVpUhq4DhxWRfSyVxpxZXCYpa1PfSKLQzhrkaq0fPWnz2PcCXOUXOBgWzJNpLYVIcXFtbPptouQgYS8jYogyEAmlqaggW7TGQ89kkDaAi98yogBPKMWiVs1pCXBUEjjayQbWfQD1aJWnF9gLd5GwiC1W2EDCSVth5L6BwyiGWIQXzNI4tH4NXCNs5jzbSZI1StKjFkUNgSIcSLgV0wJeQYCBxjUQUGNtoabYtZTCBXEDjL95SSmgfJPkZWJy9N4K6ZsHQ52AXMecuzDiaAg8F3ATnDV8rMwmQweGdO4H7HqzvMgyJ8+EtXAovF4gn1vzjUuVDEN8W/0NmgyPrVXrtS1N0GfSO7h2TpAg1G/vSKYW+jtEV4Wn28OqpRu9ENEjMkjM6vL+PV/gV8/PEnuELpDdR2kdhatB71CqruKI5cynwK2+5mhqmNxKs54kUiHw+qGKiL4F0t6eOPPwd4gwtQZltS7MpgcN3mWhVwi43jvhUGgwl8E4cUoG4NqJYEhTSQI4RaMpXmSoIEl7S1MrMhnJsVtKF7iWEy8HrUO3CD47JLd4BcBizBmqjRnTncI+L1JqCeY2BbxhLDwFIRM7r2tq3SaX0wW+c8TpXWcKfKCin6dl6W4LbLi7TMAe/BwSkXBNW4AukRAhoawvUjlbjTOmc9o1AJ/NRqbRecADSls8pQmEDp5ZT29rM90eMsqKw5spRCKHfhyLZmdilJlbj1eLc6fMeX8qOL/PC+9ThFzwdGt/d5cWpLp/uOlsBs/V9oHedda0gWcWTBRiqdOspfH9uJ4wP6Jryd3qCfqwK3Xe0TFT2KwiORCa0KNAF7Y8n5xfUVzF8Mxwet/zOKe3R1+c3rNzevGQxfpClg3QggnA3USNM76QKpe2/fjigHsV7vB7b/91eBbbMmXNLIaaniPBadX29nqfv+t4KHTNQ2EK+u11x/33m92fByetWNE5YKMte9l91P+nb0q8FRRDNcHfsiMZe6Td8AsiPnJqXuk8DnyG7f3feiD/zgFcvGgTPrZhZ2NOmcFwW6/gFPJuyDMfXi9a3IBF+7h7PSLM5K23/YerdlVj3bh0NUAsB/2aejCut1msM2m5182vqkxtbBTprj/7DZbP4DtcuImw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,P={},b=[];function w(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,o.jsx)(n(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(p(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{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,o.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(f(),{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:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},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"}},title:"folder_res"}}},title:"inline_response_200_13"}}}},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"}}}},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 I(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(w,{...e})}):w(e)}}}]);