WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-23 10:04:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
4473cd41ba7772ca9efaf0da5e67fb661042687f
OpenSign/assets/js/a2bc1463.f2a0d0c3.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"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:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var t=a(85893),l=a(11151),n=a(58219),i=(a(62316),a(51039)),o=a.n(i),r=(a(82723),a(9487)),c=a(41429),d=a(5397),m=a(4667),p=a(9472),h=a(85162);const x={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV21r3EYQ/iuT/dIG5DudY6dUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVrqzzo7TuoRQMLG1+8zrzjwz2YiAlRfZtXhpdMAieDFNREm+cNIGabTIxFVN0N/CG+kDnL27AGqsWZLzsDYtBAOOgpO0IEBQjDEzKHqNCVhnFrKUugKEwjTWUU3aywXBQtKSsagU4AKlwlzRXhKkZv1ud5AbMx+JRBhLDtm7i1Jkor9ksyIRFh02FMhxVBuhsSGRCSUbybeSA/rUkluLRDj61EpHpchmqDwlwoe1YvTMuEYkglZWmZJEFlzLt0VNDYpsIxpcyaZtRHaapokIa8tCum1ycmLLcthYVjRJt8neBT+X9qt58LDNdDtlvd4a7ckz9jhN+dfho/q2KMj7Watgn02RxFySDoxHa5Us4sX4xrPQ5r4DJr+hIqbdsZogO5OOfKvCAIfOIQcsAzX+n+W7Y37dPdIHJ3UlkpgaDMOTfezC1pO8Xh3fWE5Jl/fHKbgxBDlRzGiDUv0H+ZzoRX8wKkzDqmxt9KNdOZk8mxzHH1ZROMJA5Vn4nJpboeP0+NnRJD1Kf7iaPM9OfsxOn4/SNP1dJGLVxGj6aiwxxCiDDGr43dryG9jZ3oX1PVxSQKn8UKC/Edvt4FBqJTV93JX5Ry7xbUScfK7YL01DoWb+WZIOsHRGVwlYRegJglsDVig1KAzknny9LiDnjPtyHh/n2ZdScJKmHyf7JJzeT8KFXqCSZWTvKzMn/W0jHZoPnfn7ZSA7ULwXB8EOz7sgPRWtk2EdaX51hFYedffZ9ZQ5kBNreD5U1M2FUItMjA+nhSe32I2K1imRiToE67Px2KMuc7MaGcujqtIKc8/9PEYrxwvuybsSaO0j0D5gJXV19EWp6W2Yl/wUXbYPgr2lWCtfE3Nsn8shqh87NWHJ42LL3zMThfsMv7WkL2Wl4/ssJuLuEvCeVGEa4lEfaoId/K8//owSpSnahnSI5fME3rYO4n7A8wV1CTNFK8mjncGolFnuNwdP2CjyXq1B6kCVw0BQykoGVMBZ4e4o0GIuleSCY5jp9oJBzfoRvK8p1OT46jvHm0hJC1Jcp6CMmbOeYADbYJpoo/cZlsbNZ+xSAgh566Um78ET7URI16gLgt1bJGAcoAbSgZx10hOgbBg8Mw5oNpOFZMVca47XpgY1VsTGEmC/OQvdUkQenMlbH8Ab1cZA2GJDFLoQNVHpR/ALb0sxcD7seJJKqFpWkUBhSoK+2TgMXUJOPoBl87KgqNQHdAEULcjF2osvOWuVAmuYBSQq3sWGb8uKgkPteVJ1Du2eZp8+6wyvEtFGiesRfNAfNBMbtJ64AJTUc5990EdwvS+z95R7GWj6/a4flsvlvT54eihzLkPd5uDImlu5Kh7GrhmK7z+eikQEco1/O7skt5AF9U34gM1xBI97buTJw/zW7QLcYy/uCjBPKVmQ9jRgsrPzd29gAc9GqUgGnf8vHB6/uXj56tfLV6yXuanrv8koHaVxlzA+NKgHps4p7PfzntYOendzy/L/w12+Z69AqzC2CmXk/ZiwTc/Z1wcb/jQRtfGBjzebHD395tR2y8fdUs1MXkrPtm/X6jmtB/8JWKBq2WZk5Qew/bZ+C53yh5OMjRMm2bEpG+xkzoqC7NDAvZF6MJfOX12JRGDLMQ5ZfB5ZvP+Dte+u9Hqg+5DeOwf4X47pswI/8VO/pvXPe3h386BAH98OzS8z3W63fwN4mego",sidebar_class_name:"get 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:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",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:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV21r3EYQ/iuT/dIG5DudY6dUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVrqzzo7TuoRQMLG1+8zrzjwz2YiAlRfZtXhpdMAieDFNREm+cNIGabTIxFVN0N/CG+kDnL27AGqsWZLzsDYtBAOOgpO0IEBQjDEzKHqNCVhnFrKUugKEwjTWUU3aywXBQtKSsagU4AKlwlzRXhKkZv1ud5AbMx+JRBhLDtm7i1Jkor9ksyIRFh02FMhxVBuhsSGRCSUbybeSA/rUkluLRDj61EpHpchmqDwlwoe1YvTMuEYkglZWmZJEFlzLt0VNDYpsIxpcyaZtRHaapokIa8tCum1ycmLLcthYVjRJt8neBT+X9qt58LDNdDtlvd4a7ckz9jhN+dfho/q2KMj7Watgn02RxFySDoxHa5Us4sX4xrPQ5r4DJr+hIqbdsZogO5OOfKvCAIfOIQcsAzX+n+W7Y37dPdIHJ3UlkpgaDMOTfezC1pO8Xh3fWE5Jl/fHKbgxBDlRzGiDUv0H+ZzoRX8wKkzDqmxt9KNdOZk8mxzHH1ZROMJA5Vn4nJpboeP0+NnRJD1Kf7iaPM9OfsxOn4/SNP1dJGLVxGj6aiwxxCiDDGr43dryG9jZ3oX1PVxSQKn8UKC/Edvt4FBqJTV93JX5Ry7xbUScfK7YL01DoWb+WZIOsHRGVwlYRegJglsDVig1KAzknny9LiDnjPtyHh/n2ZdScJKmHyf7JJzeT8KFXqCSZWTvKzMn/W0jHZoPnfn7ZSA7ULwXB8EOz7sgPRWtk2EdaX51hFYedffZ9ZQ5kBNreD5U1M2FUItMjA+nhSe32I2K1imRiToE67Px2KMuc7MaGcujqtIKc8/9PEYrxwvuybsSaO0j0D5gJXV19EWp6W2Yl/wUXbYPgr2lWCtfE3Nsn8shqh87NWHJ42LL3zMThfsMv7WkL2Wl4/ssJuLuEvCeVGEa4lEfaoId/K8//owSpSnahnSI5fME3rYO4n7A8wV1CTNFK8mjncGolFnuNwdP2CjyXq1B6kCVw0BQykoGVMBZ4e4o0GIuleSCY5jp9oJBzfoRvK8p1OT46jvHm0hJC1Jcp6CMmbOeYADbYJpoo/cZlsbNZ+xSAgh566Um78ET7URI16gLgt1bJGAcoAbSgZx10hOgbBg8Mw5oNpOFZMVca47XpgY1VsTGEmC/OQvdUkQenMlbH8Ab1cZA2GJDFLoQNVHpR/ALb0sxcD7seJJKqFpWkUBhSoK+2TgMXUJOPoBl87KgqNQHdAEULcjF2osvOWuVAmuYBSQq3sWGb8uKgkPteVJ1Du2eZp8+6wyvEtFGiesRfNAfNBMbtJ64AJTUc5990EdwvS+z95R7GWj6/a4flsvlvT54eihzLkPd5uDImlu5Kh7GrhmK7z+eikQEco1/O7skt5AF9U34gM1xBI97buTJw/zW7QLcYy/uCjBPKVmQ9jRgsrPzd29gAc9GqUgGnf8vHB6/uXj56tfLV6yXuanrv8koHaVxlzA+NKgHps4p7PfzntYOendzy/L/w12+Z69AqzC2CmXk/ZiwTc/Z1wcb/jQRtfGBjzebHD395tR2y8fdUs1MXkrPtm/X6jmtB/8JWKBq2WZk5Qew/bZ+C53yh5OMjRMm2bEpG+xkzoqC7NDAvZF6MJfOX12JRGDLMQ5ZfB5ZvP+Dte+u9Hqg+5DeOwf4X47pswI/8VO/pvXPe3h386BAH98OzS8z3W63fwN4mego",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,l.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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get Contact list"})}),"\n",(0,t.jsx)(o(),{method:"get",path:"/contactlist"}),"\n",(0,t.jsx)(s.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"contactdetails[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink