mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-27 20:14:53 +02:00
1 line
8.1 KiB
JavaScript
1 line
8.1 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var i=a(85893),t=a(11151),l=a(58219),n=(a(62316),a(51039)),r=a.n(n),c=(a(82723),a(9487)),o=a(41429),d=a(5397),m=a(4667),p=a(9472),h=a(85162);const x={id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJydVt9v2zgM/lc0Pq2AGyft9mIchnVFURQb1mLp4R6SPMg2E6uRJU2S8wOB//cDZTtxkvV2HRAkDkVSJD9+pHfg+cJBMoFbrTzPvINZBDm6zArjhVaQAESgDVpOfx9ySCBrVKVwHiIw3PISPVpyswPFS4QENpfciEuvl6ggAkF+CuQ5WojA4s9KWMwh8bbCCJzfSrJxojQSIQLcGKlzhGTOpSOFrMCSQ7IDvzVB01uhFlCTKg9GCcWonFiowWaz2UA9a+5B57/ofEu2FDYqT4/cGCmykFH84ijL3fklOn3BLGRoKX8v0NGpFKXwPTVVlWlIa65tyX1fsg9uNKwjcEth3mg3rOsINqUks7awVPWUMqoj8MLLY1lNBhad0co14V4Nh/RzDKmrsgydm1eS7aGF6M0V4tbyLcHrsXS/r1wjphY6BbJXhL3kgKwpRmmxuXoxlPP3UIa3OXjRyFJEMr8ruZB/YJ8ifm4Fg0yX5Oqp0OrNoXwYXY+uwgfOsW2JlaPnQro+wqcnDdAfhh/PsX1QKy5Fzm6eHtgz8e9duMlhVlnht4GkfXYmkxmRpURfaGK30S2tfQEJxMdkd2hXHdMrK4nV3huXxDE3ZtBRUPLUUZVibkS8GgUydvePqYmafjiK4tBURnxF6qrfThJKi3rzx4Hnd12h9zwdDTvmEQeFmutwV1vXR4NqLBYqVGs1gtPZ91wIx4QLx7nOqhKVD6Rgc23ZiTVLucOcacV8geGQ5NeDEXMGMzFv+TRgUzVVY10iqxwSB6VQS5dM1SWbPM7nIhNcsn8wdcLj7H1X4PV6fVbgi2BzL3xRpcyi0Qf1RRAGFPpW+z8XEIFHW7rH+RjtSmTYgvnKVXFQjtspwbMwJbBhUyf6fGpELSxFhsphr81v7p++sevBEKJeD/2PkONvD7d338d35JW6sIFoNBgOhiSixi256l10j561obG2gY/g7e0E2nJtA3rc+NhILhR5DRHuWjpMjnbfLIKCyJJMYLcj7P+2sq5J/LNCS0ybRbDiVvCUmm0yq6OudYk/uXB0kO/X3Kuxvf/RbswL9lqYS9yecWXFZUWaUEe7VuG28Xn5TD4OGmfT/mBxk2Vo/H/q9qfH0+P4GSJI251bhjUOlq9p7/M1JDCFafNKQR7CHAjyHUiuFhVfhIEb/BK/eUV17w+HZRgO7QPVsTtS216Ux5VoUqFvSuyXBn8RV7/i9tNevTl51WD/OtNoEwyzuq7/BUJfKh8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/contactlist",title:"Get contact list",description:"",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJydVt9v2zgM/lc0Pq2AGyft9mIchnVFURQb1mLp4R6SPMg2E6uRJU2S8wOB//cDZTtxkvV2HRAkDkVSJD9+pHfg+cJBMoFbrTzPvINZBDm6zArjhVaQAESgDVpOfx9ySCBrVKVwHiIw3PISPVpyswPFS4QENpfciEuvl6ggAkF+CuQ5WojA4s9KWMwh8bbCCJzfSrJxojQSIQLcGKlzhGTOpSOFrMCSQ7IDvzVB01uhFlCTKg9GCcWonFiowWaz2UA9a+5B57/ofEu2FDYqT4/cGCmykFH84ijL3fklOn3BLGRoKX8v0NGpFKXwPTVVlWlIa65tyX1fsg9uNKwjcEth3mg3rOsINqUks7awVPWUMqoj8MLLY1lNBhad0co14V4Nh/RzDKmrsgydm1eS7aGF6M0V4tbyLcHrsXS/r1wjphY6BbJXhL3kgKwpRmmxuXoxlPP3UIa3OXjRyFJEMr8ruZB/YJ8ifm4Fg0yX5Oqp0OrNoXwYXY+uwgfOsW2JlaPnQro+wqcnDdAfhh/PsX1QKy5Fzm6eHtgz8e9duMlhVlnht4GkfXYmkxmRpURfaGK30S2tfQEJxMdkd2hXHdMrK4nV3huXxDE3ZtBRUPLUUZVibkS8GgUydvePqYmafjiK4tBURnxF6qrfThJKi3rzx4Hnd12h9zwdDTvmEQeFmutwV1vXR4NqLBYqVGs1gtPZ91wIx4QLx7nOqhKVD6Rgc23ZiTVLucOcacV8geGQ5NeDEXMGMzFv+TRgUzVVY10iqxwSB6VQS5dM1SWbPM7nIhNcsn8wdcLj7H1X4PV6fVbgi2BzL3xRpcyi0Qf1RRAGFPpW+z8XEIFHW7rH+RjtSmTYgvnKVXFQjtspwbMwJbBhUyf6fGpELSxFhsphr81v7p++sevBEKJeD/2PkONvD7d338d35JW6sIFoNBgOhiSixi256l10j561obG2gY/g7e0E2nJtA3rc+NhILhR5DRHuWjpMjnbfLIKCyJJMYLcj7P+2sq5J/LNCS0ybRbDiVvCUmm0yq6OudYk/uXB0kO/X3Kuxvf/RbswL9lqYS9yecWXFZUWaUEe7VuG28Xn5TD4OGmfT/mBxk2Vo/H/q9qfH0+P4GSJI251bhjUOlq9p7/M1JDCFafNKQR7CHAjyHUiuFhVfhIEb/BK/eUV17w+HZRgO7QPVsTtS216Ux5VoUqFvSuyXBn8RV7/i9tNevTl51WD/OtNoEwyzuq7/BUJfKh8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get contact list"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/contactlist"}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'[\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n]',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); |