WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 04:24:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
02c0faacf63240299d33e664cdc0dbd4f8457459
OpenSign/assets/js/a2bc1463.3d033c79.js
T

1 line
10 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>g,frontMatter:()=>j,metadata:()=>u,toc:()=>v});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),m=s(5397),d=s(4667),p=s(9472),h=s(85162);const j={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:"eJzNVm1r40YQ/ivb+dQD2ZbzcqWilAtHCOHCXSAphSbmWEtja+LV7t7uyrEx+u9lVrItx5e2V45SMLY18zzztjOj3UCQcw/ZA7w3Osg8eJgkUKDPHdlARkMG9yWKTituyAdxcXstsLLmGZ0Xa1OLYITD4AiXKKRQjDEzkXcWE2GdWVJBei6kyE1lHZaoPS1RLAmfGSuVEnIpScmpwh1TkGb7biuYGrMYQgLGopMc3XUBGXRKdgsJWOlkhQEdZ7UBLSuEDBRVxFrihL7U6NaQgMMvNTksIJtJ5TEBH9aK0TPjKkgAV1aZAiELrmZtXmIlIdtAJVdU1RVk52maQFhbJum6mqKDhnmysmxonDbJLgS/IPvdInjdZ9pM2K63Rnv0jD1JU/45PFRf5zl6P6uV2FUTklhL1IHx0lpFeVSMnjyTNscBmOkT5rHsjs0Eal069LUKPZx0TnLCFLDyf89vxXy6O6QPjvQcklgaGfqSXe5gy/G0XJ08WS7Jx1j3bzPwZFBMEZl+WUlS/4I/RXzXCYa5qdjUbWn0N4dyNj4dn8QPm8gdyoDFRfiamT3pJD05HYzTQfrT/fhtdvZzdv52mKbpH5DAqorZdN1YyBCzDBRU/7m2xX/gp3kJ62a4wCBJ+T6h00DT9ISkFWn8vG3zz9ziTUScpefHzX6tl1JRERfXvVmg/uH7tTo6Z9xfF6vvPrTujytALSjq4SDVvrxN0mNeOwrruOFWA2lp0OqzhwmPf4WhNLwa59iuxFBCBqPDRenRLbdbsnYKMihDsD4bjXyQc9LzgbR2aCxv6rlWcuq5nUfS0mg5BnazDeOOS9VW4yCY/fRb+oA8/l2ufVS3EUuUBW+yhp9nJpK7CnyyqO9ormP9lmM4fj+RF+SjujB5XaEO8SzFzDjxgi2m0mMhjBahxKhk+elwLLzFnGZdGwzFo37Ud6ZCUXvkLalIL3z2qAfi4dNsRjlJJX7HqaeAkx+3lXt+fj6q2JvIuaJQ1lPh0Jo9fB6Fsax91u7hDSQQ0FX+0+wO3ZJy7E7pFVejCB51zc1Tww3a7rGt6N1LEjebohy1x147Xlzd3ojTYQpJrzn+Qcijm+v3lx/vLtkqt1d7RONhOkxZZI0PldQ9R1cYtq930XXmwfFu9oP6P7yJdA0ecBVGVkmKoxsLtunG7uHgfjJJoDQ+sHiz4Vb8zammYXF7JeBhLMiz7/2lYIHr3hVmKVXNPoHvFq9gu7vGHjrhB0eMjUsi2Q4cO2w5F3mOtu/gaCserJary3tIQNacY3/QF3HQuz9sfavS657tww3QBsDfnNNXCb/wUX/A9a87eKt5ldDlt0XzyUyapvkTooq1Gw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={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:"eJzNVm1r40YQ/ivb+dQD2ZbzcqWilAtHCOHCXSAphSbmWEtja+LV7t7uyrEx+u9lVrItx5e2V45SMLY18zzztjOj3UCQcw/ZA7w3Osg8eJgkUKDPHdlARkMG9yWKTituyAdxcXstsLLmGZ0Xa1OLYITD4AiXKKRQjDEzkXcWE2GdWVJBei6kyE1lHZaoPS1RLAmfGSuVEnIpScmpwh1TkGb7biuYGrMYQgLGopMc3XUBGXRKdgsJWOlkhQEdZ7UBLSuEDBRVxFrihL7U6NaQgMMvNTksIJtJ5TEBH9aK0TPjKkgAV1aZAiELrmZtXmIlIdtAJVdU1RVk52maQFhbJum6mqKDhnmysmxonDbJLgS/IPvdInjdZ9pM2K63Rnv0jD1JU/45PFRf5zl6P6uV2FUTklhL1IHx0lpFeVSMnjyTNscBmOkT5rHsjs0Eal069LUKPZx0TnLCFLDyf89vxXy6O6QPjvQcklgaGfqSXe5gy/G0XJ08WS7Jx1j3bzPwZFBMEZl+WUlS/4I/RXzXCYa5qdjUbWn0N4dyNj4dn8QPm8gdyoDFRfiamT3pJD05HYzTQfrT/fhtdvZzdv52mKbpH5DAqorZdN1YyBCzDBRU/7m2xX/gp3kJ62a4wCBJ+T6h00DT9ISkFWn8vG3zz9ziTUScpefHzX6tl1JRERfXvVmg/uH7tTo6Z9xfF6vvPrTujytALSjq4SDVvrxN0mNeOwrruOFWA2lp0OqzhwmPf4WhNLwa59iuxFBCBqPDRenRLbdbsnYKMihDsD4bjXyQc9LzgbR2aCxv6rlWcuq5nUfS0mg5BnazDeOOS9VW4yCY/fRb+oA8/l2ufVS3EUuUBW+yhp9nJpK7CnyyqO9ormP9lmM4fj+RF+SjujB5XaEO8SzFzDjxgi2m0mMhjBahxKhk+elwLLzFnGZdGwzFo37Ud6ZCUXvkLalIL3z2qAfi4dNsRjlJJX7HqaeAkx+3lXt+fj6q2JvIuaJQ1lPh0Jo9fB6Fsax91u7hDSQQ0FX+0+wO3ZJy7E7pFVejCB51zc1Tww3a7rGt6N1LEjebohy1x147Xlzd3ojTYQpJrzn+Qcijm+v3lx/vLtkqt1d7RONhOkxZZI0PldQ9R1cYtq930XXmwfFu9oP6P7yJdA0ecBVGVkmKoxsLtunG7uHgfjJJoDQ+sHiz4Vb8zammYXF7JeBhLMiz7/2lYIHr3hVmKVXNPoHvFq9gu7vGHjrhB0eMjUsi2Q4cO2w5F3mOtu/gaCserJary3tIQNacY3/QF3HQuz9sfavS657tww3QBsDfnNNXCb/wUX/A9a87eKt5ldDlt0XzyUyapvkTooq1Gw==",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:"Create document",permalink:"/docs/API-docs/createdocument"}},f={},v=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"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)(a.p,{children:"Get contact list"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,t.jsx)(a.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)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{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)(a.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,t.jsx)(o.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)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.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)(s,{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)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{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)(a.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(d.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)(d.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)(a.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.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:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.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)(s,{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)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink