WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-10-01 14:04:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
1be2b94cd3c25d9ccdc5d6fc8b8232e96b56b09e
OpenSign/assets/js/a2bc1463.b1ad234a.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:()=>b,contentTitle:()=>j,default:()=>f,frontMatter:()=>x,metadata:()=>u,toc:()=>v});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(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:"eJzNVm1r40YQ/ivb+dQD2ZaT3JWKUi4cIYQLl0BSCk3MsZbG1sSr3b3dlWNj9N/LrGRbji9tr5SjYGxr5nlmdl61Gwhy7iF7gA9GB5kHD5MECvS5IxvIaMjgvkTRacU1+SDOb68EVtY8o/NibWoRjHAYHOEShRSKMWYm8s5iIqwzSypIz4UUuamswxK1pyWKJeEzY6VSQi4lKTlVuGMK0mzfbQVTYxZDSMBYdJJPd1VABp2S3UICVjpZYUDHUW1AywohA0UVsZY4oC81ujUk4PBLTQ4LyGZSeUzAh7Vi9My4ChLAlVWmQMiCq1mbl1hJyDYQ1pZhuq6m6KBhpKwsU8dpk+yc+gXZ7+AzbSZs11ujPXrGnqQp/xyW0dd5jt7PaiV2+YMkZg91YLy0VlEeFaMnz6TN8QHM9AnzmGjHZgK1Lh36WoUeTjonOWAKWPm/57dirucO6YMjPYckpkaGvmQXO9hyPC1XJ0+WU/Ip5v3bDDwZFFNEpl9UktS/4E8R33eCYW4qNnVbGv3NRzkbn45P4odN5A5lwOI8fM3MnnSSnpwOxukg/el+/C47+zl7+26YpukfkMCqitF03VjIEKMMFFT/ubbFd/DTvIR1U1tgkKR8n9BpoGl6QtKKNH7etvlnbvEmIs7St8fNfqWXUlERV9W9WaD+4b9rdXTOuL9OVt99aN0fZ4BaUNTDQah9eRukx7x2FNZxp60G0tKg1WcPEx7/CkNpeBnOsV2CoYQMRoer0aNbbvdi7RRkUIZgfTYa+SDnpOcDae3QWN7Nc63k1HM7j6Sl0XIM7GZ7jDtOVZuNg8Psp9/SR+Tx72Lto7qNWKIseJM1/Dwzkdxl4MaivqO5jvlbjuH4jURekI/qwuR1hTrEWoqZceIFW0ylx0IYLUKJUcny0+FYeIs5zbo2GIpH/ajvTIWi9shbUpFe+OxRD8TDzWxGOUklfsepp4CTH7eZe35+PsrYm8i5pFDWU+HQmj18HoUxrX3W7uENJBDQVf5mdoduSTl2VXrF1SiCR11z89Rwg7Z7bCt6/5LEzaYoR+2x147nl7fX4nSYQtJrjn9w5NH11YeLT3cXbJXbqy3ReJgOUxZZ40Mldc/RJYbtC110nXlQ3s1+UP+Hd4+uwQOuwsgqSXF0Y8I23dg9HNxIJgmUxgcWbzbcir851TQsbq8EPIwFefa9vxQscN27tCylqtkn8N3iFWx319hDJ/zgiLFxSSTbgWOHLec8z9H2HRxtxYPVcnlxDwnImmPsD/oiDnr3h61vVXrds324AdoD8DfH9FXCL1zqj7j+dQdvNa8Suvi2aK7MpGmaPwF9YrDe",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=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+dQD2ZaT3JWKUi4cIYQLl0BSCk3MsZbG1sSr3b3dlWNj9N/LrGRbji9tr5SjYGxr5nlmdl61Gwhy7iF7gA9GB5kHD5MECvS5IxvIaMjgvkTRacU1+SDOb68EVtY8o/NibWoRjHAYHOEShRSKMWYm8s5iIqwzSypIz4UUuamswxK1pyWKJeEzY6VSQi4lKTlVuGMK0mzfbQVTYxZDSMBYdJJPd1VABp2S3UICVjpZYUDHUW1AywohA0UVsZY4oC81ujUk4PBLTQ4LyGZSeUzAh7Vi9My4ChLAlVWmQMiCq1mbl1hJyDYQ1pZhuq6m6KBhpKwsU8dpk+yc+gXZ7+AzbSZs11ujPXrGnqQp/xyW0dd5jt7PaiV2+YMkZg91YLy0VlEeFaMnz6TN8QHM9AnzmGjHZgK1Lh36WoUeTjonOWAKWPm/57dirucO6YMjPYckpkaGvmQXO9hyPC1XJ0+WU/Ip5v3bDDwZFFNEpl9UktS/4E8R33eCYW4qNnVbGv3NRzkbn45P4odN5A5lwOI8fM3MnnSSnpwOxukg/el+/C47+zl7+26YpukfkMCqitF03VjIEKMMFFT/ubbFd/DTvIR1U1tgkKR8n9BpoGl6QtKKNH7etvlnbvEmIs7St8fNfqWXUlERV9W9WaD+4b9rdXTOuL9OVt99aN0fZ4BaUNTDQah9eRukx7x2FNZxp60G0tKg1WcPEx7/CkNpeBnOsV2CoYQMRoer0aNbbvdi7RRkUIZgfTYa+SDnpOcDae3QWN7Nc63k1HM7j6Sl0XIM7GZ7jDtOVZuNg8Psp9/SR+Tx72Lto7qNWKIseJM1/Dwzkdxl4MaivqO5jvlbjuH4jURekI/qwuR1hTrEWoqZceIFW0ylx0IYLUKJUcny0+FYeIs5zbo2GIpH/ajvTIWi9shbUpFe+OxRD8TDzWxGOUklfsepp4CTH7eZe35+PsrYm8i5pFDWU+HQmj18HoUxrX3W7uENJBDQVf5mdoduSTl2VXrF1SiCR11z89Rwg7Z7bCt6/5LEzaYoR+2x147nl7fX4nSYQtJrjn9w5NH11YeLT3cXbJXbqy3ReJgOUxZZ40Mldc/RJYbtC110nXlQ3s1+UP+Hd4+uwQOuwsgqSXF0Y8I23dg9HNxIJgmUxgcWbzbcir851TQsbq8EPIwFefa9vxQscN27tCylqtkn8N3iFWx319hDJ/zgiLFxSSTbgWOHLec8z9H2HRxtxYPVcnlxDwnImmPsD/oiDnr3h61vVXrds324AdoD8DfH9FXCL1zqj7j+dQdvNa8Suvi2aK7MpGmaPwF9YrDe",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"}},b={},v=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.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:{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)(l.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)(m.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)(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)(a.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:"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)(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 f(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink