Files
OpenSign/assets/js/b3eb04bc.a124905a.js
T

1 line
12 KiB
JavaScript

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1210],{53630(e,t,o){o.r(t),o.d(t,{assets:()=>f,contentTitle:()=>j,default:()=>w,frontMatter:()=>y,metadata:()=>i,toc:()=>V});const i=JSON.parse('{"id":"API-docs/v1.2/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.2/folderlist.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/folderlist","permalink":"/docs/API-docs/v1.2/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":"eJy9GdtuI7f1V05ngWItjC52simqFGkdr+M43e4alt0FahkeauZIwxWHnJAcyYItIA9FP6DoS1/7E33vp+yXFIccjkays7tu0jwkXpHnfueZu8iymYmGV9E3SmSoo+s4ytCkmpeWKxkNo4scwd/BK24sHJ6dAhalWqI2sFIVWAUarea4QGAgCEZNYepRltzmoPxfVVkomUZpPb3TLIojVaJmxOo0i4aRxyIaURyVTLMCLWqS7y6SrMBoGD2gwEnK7yvUq2hXdjV5h6k9zTYCRXGk8fuKa8yi4ZQJg3Fk7EqgY66LKI7wthQqw811mmPBouFdZFclwRmruZxFsUNgtn2Ct6woHbFovY4bmQUvuN0V9ZPlsLraEqNgt7yoimj4YjCIg1CyKiaoo3VLhv1BSwQz5+XPJsGP8xysr4muKZU0aAj2YDCgP9uOMVWaojHTSkATAFEcpUpalJbgWVkKnrqL/jtDSHcPBfD+pVDRRMZyz1KjqYRtwTGtGSnMLRbm4/ghbJ7q8zLfn+S3B+9KMomPt9fO+k8jI3EZonUd78b7E2l9dyCZeTHnZ7hL63+VzFSTlnSpRmYxO7SPkdogHgwOPuvuD7qD31zsfzH8/LfDF1/0BoPBX6I4ui0E4dZhmjHrJLXcivbvqsx+AT6tA6/ijUYTrdvnXAou8SaE+M3BYHCz/xnBrOPo88difaQKtDmXM1iitLDUSs5iKAUyg2D1CtiMcQmCWdS/+vmSALVW+sPWeppkH7LC52SFxggvHhrhVC6Y4JnrHhdqjvKX1bTN3nr2JOp2THAP5O6jLWXb515Jg2mluV25znTbZSXv+vvh1TWVQDKsoo42Q9/KbB4No/5WfzOoF6G5VVpEwyi3tjTDft8wmU3UbU+VKA2fScEmppeqos9K3l/s9w4iquzbOKwsnwSPVfepKMayGZezj+Fdb8wzIhd6L20ZaVOZS/5HpNJc+6ANVXerHJkrNmv6PVUOufbMmxLliM+k86tjvjsBPIMA8/6v/2rAxnIsv4JOh2YbUqRrVKVThJcqrRw9JixqySxfILz/4R8wqbiwMFUaMlygoOgzMVhdGYsZTFaA0qIuNTdoep0O0W/znfEF+mGJQaooJi3GUGqVVSkJ2tXIshVglyzKbKURSsEslWKwuVbVLAcGhsuZwBjOj0cX1DkPz057MEKZQabSqkBpjROxIRJDwSSbIVgsiB46mVk6dyCU98YyWxngEjQyAZYXGAOTGbDKqoJZJKE1acc1NmxA8Cmmq1R44zAhmvlugTJTGoRK510ue2SIbrdLf549gxO0lriOLNMWMzo9XqBeAQ0iaCwUlbGQMq1Xnm+TriShzRGSVnwk4CPDMUmSZCxbl0P4HVHYHHxVw4xlp/P+b3+Hq2/VkkbXGUqaP3CH4fXzEPSZSs3DaKfTfo6i7I+8UqZ/eHbqKtue9/9rZcGQJ5c5aiRWE5xx+Xu4pOKaI3Q6dZoDygXXSpJpOx14nnxyGUj2iG6plVWUT40X2HSKqTO1oAjOmGU7rjhSGuGIlWzCBadCSuf3cMQszpRewT28zZl1IZsyCZmC+7G873a77j8C7XRehqjrdOAejtwkEINBmcXg+3UMGhdqXsdUhhT3m/DsBrdvwremfBHi1VH+uuIiA42VYRPRCmb/uCg1dkvBUsxgybMZWvOlk4EsoyTS46NgcuXY0pOlZjFCMe1SfjoWJyEKDB070HZWNXatqQCXC25dt4KpUMtA9KyaCJ7CtvijnGl6GZX+MqSe4HLu0keqQNW9ncJQHmi+1Gxq4a3Sc+LkKbIFtqRTumUTZiAjDONMPuWSCe4DrvCNPNA9UtKytHben3ydcDlQC5P6e5goNacQm2lWFMzylAmxCkT8KOlpvNEzJonXRjIuDc+wKcHwUlM4+ibYeOItTnKl5p7IOaZIMFSOulSOABdUcaSyfFoPCAZ8ZGpQSwkos1JxaQO5SxMEOm9epWmqKmmdRVKNGbdAnYTmXPLg/XZqUOC//+GfBl7jkupOaBh0+QwOrWVp7qrgWxduMKrKUmk7ltRNEtbcm6QOSOAGpKLJ2QFiBkp6JzWmisEP0q0DDxAc2wBsDkibOqbCIdUv0wuifku2H3lvjuqoe8Xl3IzlCC0k4yjnGd54f9/UcXkjHEQ0pO6GcA/uaZiQyMnZm9EF9J1gQc6E0ozIhLBph7cJZXtbWQhjY29j1iOBjNBD6gTnMTGWycnxBfSDjv0hzxKn/PY5JU8COaXGBFGCsRpZQWNq5tJMY1bJjEm3g6j3CkCZqbFQC8wcyU6n1DjlQriaGRyn0Vaa6BgkXItiBVOtiqDzhmCnQz13TgZoHsGAzHDUZKhUSVMV2HjojBmzVDrrnmllMaXQOHv5zSai6J78NOUCb8oaeBwlwa6hgE5UtqI+I2GptOPuSiPKVK/KmqrpBbouAIdjWfvTB1YwYwL/+TckZ5cPLO6OWwjBm/1hgLvZBtuJk52LHX7ugoovmTQJ9nkznZIDm+ilmqWVaOKXCaGWN8pDuQj+UODuKupi6BFNrQLafPCUW0GTnes6NPpx34Bqfk2o08yFLM2bNGz8WyffuRLUYF19qNtQAv4x4+KLpSmWVLFJpzodtRJInp5yFBmwVCtj3KTltKCypVVl0fTgIteIQPA+npsyM/Q9nbhTF8WcLThVzd1OXsuUQOd5hlNWCbvneoIbxupplUouvQut66mbMbWucJ7OguOS6DRl3PjsD3lPhtJIUKCkWIXuV7dtcN4MjS9hZanVwpM7YtJnNjXyAI63ZLW6J3tp6t7pmN03pYXpiZJwpMoVPD862iPheMmpQo/lIdBOIxlHabqx9oN6zYSSM9fKSB+85cYNV8k4mrTxqKw39XtTqH31o2hrpovGi30/KDXOPC4YF8CyTKOh2kFVDTPK90ZGXbdIRpPyRMluSpq1GySgo6JkitsO4KZxaNaDV3yOGx1iEn9LGnhuqjSnicJnySbjeZbs0Uyw4FltBy8a+UvzrPZ705UWTFQYu07uqxRZVnAyLI0ptE62K3BLOnieXF0ne1+CKrh1VLxprQIuc9T14Tbpndn2cMG4cJl6vBms6wG3dUI5QYuOy/NXjwy3Iz97u0HiCQN5Mwk2b7ttCh98OjfYx5dwjrMHyB97sie7o8yfURuuXJH6NXzN0vmS6czAkSpKZrkb/VcESsgUHNOKZrtJAOymNaDwTwtY7LswXuz39puXX5i/jG+JNlcGYeEZ+4LEGn8oalvcwCTY3VGVCiYafddMcyZnlAg0fLUaNafCn1WpzwUnL5FW7p3PBFRSoDGgbI56SUOoVBTj2+a4NEjv5noGGssuXDWj6VucGG5x8+5bLpcPLL3ncL6phIDw+HEJ95HXokc74fbbagLnWCrDrdKrDdaM27yaOF+2cZsfNYHwSGmWaD/llepIXqAuDH0dGaFe8PQj6vctgff3xrSb2dnnbK9dNE5RU90xW29sVvL6PX8V5AAS76fo4bbQ/q3iloFU+vxi6Q+7dNxSj1R4M631rZdbH9Y3iiPBU5QGW8vCw5OzV7D4rDeI4taW7BN82X91enT8enRMwtRpEg2j/d6gN3AremVswWSL0wna8DWtXhxu2fpus0b9f3+rq3d2Fm9tvxSMuy2pU/6u3nBetb/gXcdRroyl07s7SvlLLdZrOvYfoGjvWc9Um09QP6rbo9/yHpVojqvHvhO6VuG+zMWP8PVI4UPdp8DWX9Q2oNf0Q3OCdWvgOKwuSVGPc+gmvRbWg7331vL45PgiiiNWkWnbK9O5W5nW/yDq4UquWrS3d6leAPo/6fQowt2dX8eu1w28v/pRjFrBAE32v16v1/8FpUSviQ==","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 Folder","permalink":"/docs/API-docs/v1.2/deletefolder"},"next":{"title":"v1.1","permalink":"/docs/API-docs/v1.1"}}');var n=o(74848),r=o(28453),a=o(57742),s=o.n(a),l=o(78178),p=o.n(l),d=o(19624),m=o.n(d),u=o(96226),c=o.n(u),b=(o(77675),o(19365),o(51107)),S=o(21312);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:"eJy9GdtuI7f1V05ngWItjC52simqFGkdr+M43e4alt0FahkeauZIwxWHnJAcyYItIA9FP6DoS1/7E33vp+yXFIccjkays7tu0jwkXpHnfueZu8iymYmGV9E3SmSoo+s4ytCkmpeWKxkNo4scwd/BK24sHJ6dAhalWqI2sFIVWAUarea4QGAgCEZNYepRltzmoPxfVVkomUZpPb3TLIojVaJmxOo0i4aRxyIaURyVTLMCLWqS7y6SrMBoGD2gwEnK7yvUq2hXdjV5h6k9zTYCRXGk8fuKa8yi4ZQJg3Fk7EqgY66LKI7wthQqw811mmPBouFdZFclwRmruZxFsUNgtn2Ct6woHbFovY4bmQUvuN0V9ZPlsLraEqNgt7yoimj4YjCIg1CyKiaoo3VLhv1BSwQz5+XPJsGP8xysr4muKZU0aAj2YDCgP9uOMVWaojHTSkATAFEcpUpalJbgWVkKnrqL/jtDSHcPBfD+pVDRRMZyz1KjqYRtwTGtGSnMLRbm4/ghbJ7q8zLfn+S3B+9KMomPt9fO+k8jI3EZonUd78b7E2l9dyCZeTHnZ7hL63+VzFSTlnSpRmYxO7SPkdogHgwOPuvuD7qD31zsfzH8/LfDF1/0BoPBX6I4ui0E4dZhmjHrJLXcivbvqsx+AT6tA6/ijUYTrdvnXAou8SaE+M3BYHCz/xnBrOPo88difaQKtDmXM1iitLDUSs5iKAUyg2D1CtiMcQmCWdS/+vmSALVW+sPWeppkH7LC52SFxggvHhrhVC6Y4JnrHhdqjvKX1bTN3nr2JOp2THAP5O6jLWXb515Jg2mluV25znTbZSXv+vvh1TWVQDKsoo42Q9/KbB4No/5WfzOoF6G5VVpEwyi3tjTDft8wmU3UbU+VKA2fScEmppeqos9K3l/s9w4iquzbOKwsnwSPVfepKMayGZezj+Fdb8wzIhd6L20ZaVOZS/5HpNJc+6ANVXerHJkrNmv6PVUOufbMmxLliM+k86tjvjsBPIMA8/6v/2rAxnIsv4JOh2YbUqRrVKVThJcqrRw9JixqySxfILz/4R8wqbiwMFUaMlygoOgzMVhdGYsZTFaA0qIuNTdoep0O0W/znfEF+mGJQaooJi3GUGqVVSkJ2tXIshVglyzKbKURSsEslWKwuVbVLAcGhsuZwBjOj0cX1DkPz057MEKZQabSqkBpjROxIRJDwSSbIVgsiB46mVk6dyCU98YyWxngEjQyAZYXGAOTGbDKqoJZJKE1acc1NmxA8Cmmq1R44zAhmvlugTJTGoRK510ue2SIbrdLf549gxO0lriOLNMWMzo9XqBeAQ0iaCwUlbGQMq1Xnm+TriShzRGSVnwk4CPDMUmSZCxbl0P4HVHYHHxVw4xlp/P+b3+Hq2/VkkbXGUqaP3CH4fXzEPSZSs3DaKfTfo6i7I+8UqZ/eHbqKtue9/9rZcGQJ5c5aiRWE5xx+Xu4pOKaI3Q6dZoDygXXSpJpOx14nnxyGUj2iG6plVWUT40X2HSKqTO1oAjOmGU7rjhSGuGIlWzCBadCSuf3cMQszpRewT28zZl1IZsyCZmC+7G873a77j8C7XRehqjrdOAejtwkEINBmcXg+3UMGhdqXsdUhhT3m/DsBrdvwremfBHi1VH+uuIiA42VYRPRCmb/uCg1dkvBUsxgybMZWvOlk4EsoyTS46NgcuXY0pOlZjFCMe1SfjoWJyEKDB070HZWNXatqQCXC25dt4KpUMtA9KyaCJ7CtvijnGl6GZX+MqSe4HLu0keqQNW9ncJQHmi+1Gxq4a3Sc+LkKbIFtqRTumUTZiAjDONMPuWSCe4DrvCNPNA9UtKytHben3ydcDlQC5P6e5goNacQm2lWFMzylAmxCkT8KOlpvNEzJonXRjIuDc+wKcHwUlM4+ibYeOItTnKl5p7IOaZIMFSOulSOABdUcaSyfFoPCAZ8ZGpQSwkos1JxaQO5SxMEOm9epWmqKmmdRVKNGbdAnYTmXPLg/XZqUOC//+GfBl7jkupOaBh0+QwOrWVp7qrgWxduMKrKUmk7ltRNEtbcm6QOSOAGpKLJ2QFiBkp6JzWmisEP0q0DDxAc2wBsDkibOqbCIdUv0wuifku2H3lvjuqoe8Xl3IzlCC0k4yjnGd54f9/UcXkjHEQ0pO6GcA/uaZiQyMnZm9EF9J1gQc6E0ozIhLBph7cJZXtbWQhjY29j1iOBjNBD6gTnMTGWycnxBfSDjv0hzxKn/PY5JU8COaXGBFGCsRpZQWNq5tJMY1bJjEm3g6j3CkCZqbFQC8wcyU6n1DjlQriaGRyn0Vaa6BgkXItiBVOtiqDzhmCnQz13TgZoHsGAzHDUZKhUSVMV2HjojBmzVDrrnmllMaXQOHv5zSai6J78NOUCb8oaeBwlwa6hgE5UtqI+I2GptOPuSiPKVK/KmqrpBbouAIdjWfvTB1YwYwL/+TckZ5cPLO6OWwjBm/1hgLvZBtuJk52LHX7ugoovmTQJ9nkznZIDm+ilmqWVaOKXCaGWN8pDuQj+UODuKupi6BFNrQLafPCUW0GTnes6NPpx34Bqfk2o08yFLM2bNGz8WyffuRLUYF19qNtQAv4x4+KLpSmWVLFJpzodtRJInp5yFBmwVCtj3KTltKCypVVl0fTgIteIQPA+npsyM/Q9nbhTF8WcLThVzd1OXsuUQOd5hlNWCbvneoIbxupplUouvQut66mbMbWucJ7OguOS6DRl3PjsD3lPhtJIUKCkWIXuV7dtcN4MjS9hZanVwpM7YtJnNjXyAI63ZLW6J3tp6t7pmN03pYXpiZJwpMoVPD862iPheMmpQo/lIdBOIxlHabqx9oN6zYSSM9fKSB+85cYNV8k4mrTxqKw39XtTqH31o2hrpovGi30/KDXOPC4YF8CyTKOh2kFVDTPK90ZGXbdIRpPyRMluSpq1GySgo6JkitsO4KZxaNaDV3yOGx1iEn9LGnhuqjSnicJnySbjeZbs0Uyw4FltBy8a+UvzrPZ705UWTFQYu07uqxRZVnAyLI0ptE62K3BLOnieXF0ne1+CKrh1VLxprQIuc9T14Tbpndn2cMG4cJl6vBms6wG3dUI5QYuOy/NXjwy3Iz97u0HiCQN5Mwk2b7ttCh98OjfYx5dwjrMHyB97sie7o8yfURuuXJH6NXzN0vmS6czAkSpKZrkb/VcESsgUHNOKZrtJAOymNaDwTwtY7LswXuz39puXX5i/jG+JNlcGYeEZ+4LEGn8oalvcwCTY3VGVCiYafddMcyZnlAg0fLUaNafCn1WpzwUnL5FW7p3PBFRSoDGgbI56SUOoVBTj2+a4NEjv5noGGssuXDWj6VucGG5x8+5bLpcPLL3ncL6phIDw+HEJ95HXokc74fbbagLnWCrDrdKrDdaM27yaOF+2cZsfNYHwSGmWaD/llepIXqAuDH0dGaFe8PQj6vctgff3xrSb2dnnbK9dNE5RU90xW29sVvL6PX8V5AAS76fo4bbQ/q3iloFU+vxi6Q+7dNxSj1R4M631rZdbH9Y3iiPBU5QGW8vCw5OzV7D4rDeI4taW7BN82X91enT8enRMwtRpEg2j/d6gN3AremVswWSL0wna8DWtXhxu2fpus0b9f3+rq3d2Fm9tvxSMuy2pU/6u3nBetb/gXcdRroyl07s7SvlLLdZrOvYfoGjvWc9Um09QP6rbo9/yHpVojqvHvhO6VuG+zMWP8PVI4UPdp8DWX9Q2oNf0Q3OCdWvgOKwuSVGPc+gmvRbWg7331vL45PgiiiNWkWnbK9O5W5nW/yDq4UquWrS3d6leAPo/6fQowt2dX8eu1w28v/pRjFrBAE32v16v1/8FpUSviQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},j=void 0,f={},V=[];function O(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,n.jsx)(s(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,n.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(S.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(p(),{...o(95257)}),"\n",(0,n.jsx)(m(),{...o(95619)}),"\n",(0,n.jsx)(c(),{...o(30149)})]})}function w(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(O,{...e})}):O(e)}},95257(e){e.exports=JSON.parse('{"parameters":[{"name":"parentFolderId","in":"query","description":"objectId of folder","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"string","example":""}},{"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}]}')},95619(e){e.exports={title:"Body"}},30149(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":"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"}}}}}}')}}]);