WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-06 17:57:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
ef74da02c706f6aefbfc8b41c4e95a6d7d7ca9ab
OpenSign/assets/js/a2bc1463.1fef8831.js
T

1 line
12 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:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),c=s(41429),m=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={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:"eJzNVm1r3EYQ/iuT/dIG5Dud46RUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVro7nR2nTQmhYGxr95nXnXlmNiJg5UV2I14YHbAIXkwTUZIvnLRBGi0ycV0T9LfwWvoA528vgRprluQ8rE0LwYCj4CQtCBAUY8wMil5jAtaZhSylrgChMI11VJP2ckGwkLRkLCoFuECpMFe0lwSpWb/bHeTGzEciEcaSQ/bushSZ6C/ZrEiERYcNBXIc1UZobEhkQslG8q3kgD625NYiEY4+ttJRKbIZKk+J8GGtGD0zrhGJoJVVpiSRBdfybVFTgyLbiAZXsmkbkT1N00SEtWUh3TY5ObFlOWwsK5qk22Tvgp9L+9U8eNhmup2yXm+N9uQZe5qm/Of4UX1bFOT9rFWwz6ZIYi5JB8ajtUoW8WJ861loc98Bk99SEdPuWE2QnUlHvlVhgEPnkAOWgRr/z/LdMb/uHumDk7oSSUwNhuHJPnZh60ler05vLaeky/uXKbg1BDlRzGiDUv0H+ZzoeX8wKkzDqmxt9Be7cjZ5MjmNP6yicISByvPwKTUHodP09MnJJD1Jf7iePMvOfsyePhulafq7SMSqidH01VhiiFEGGdTwu7XlN7CzvQvre7ikgFL5oUB/I7bbwaHUSmr6sCvzD1zi24g4+1SxX5mGQs38syQdYOmMrhKwitATBLcGrFBqUBjIPfp6XUDOGff5PH6ZZ59LwVmafpjsk/D0fhIu9QKVLCN7X5s56W8b6dB86MzfLwPZgeK9OAp2eN4F6alonQzrSPOrE7TypLvPbqbMgZxYw/Ohom4uhFpkYnw8LTy5xW5UtE6JTNQhWJ+Nx2jtyFgeU5VWmHvu5TFaOV5wP95F+4CV1NXJZ6WmB6evOLFd7o5cPxCmla+IGbPPzBDVD5GasGTy3/L3zEThPl9vLOkrWemY7cVE3B3p70gVpiEe3KEm2MH/+uPPKFGaom1Ih1gMj+BN6yBOe54WqEuYKVpJHtQMRqXMcr8HeMJGkfdqDVIHqhwGglJWMqACzgrXeoEWc6kklw/DTDflBxXoR/CuplCT46vvHO8VJS1IcdWBMmbOeoIBbINpoo3eZ1gaN5+xSwkg5K2XmrwHT7QTIV2jLgh2b5GAcYAaSAdy1klPgLJh8Mw4oNlMFpIVc+U4XoIa1FgRG0uA/eYsdCsOeXAmb30Ab1QbA2GLDVHoQtREpR/BL7z7xMD5sGM9KqFqWUUChSkJ+tbhMHQJOfkAls3LgqJSH9AFULQgF2svvuSsVQqs4Z6WqHizGr4tKwoOtee50zm0e5p9+qwzvBhEGyWuR/Bev9dMU9B64gJQUs999l6fwM2+zN5R7mWg6fe7flgul/f64PGxzIUMdZuDI2sOclU8jF0zFN9/PBaJCOQa/2Z2RW4hC+qb8AGb4wge90zHc4TZqpvs3GPP7wow6yhZkPY04KXzi7evYQFPRqlIBp3/Lxwev7588fLXq5esl5mm67/JKB2lcTMwPjSoB6YuKOy37Z6kjnp3c+Ds/+Fm3rNXoFUYW4UysnhM2KZn4JujfX2aiNr4wMebTY6efnNqu+XjbkVmXi6lZ9uHJXlO68FKv0DVss3Iyg9g+937AJ3yh5OMjfMi2bEpG+xkzouC7NDAvQF5NGUuXl6LRGDLMQ5ZfB5ZvP+Hte+u9Hqg+5jeOwf4N8f0SYGf+Klf0frnPby7eVCgj2+H5peZbrfbvwFDgtZW",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=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:"eJzNVm1r3EYQ/iuT/dIG5Dud46RUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVro7nR2nTQmhYGxr95nXnXlmNiJg5UV2I14YHbAIXkwTUZIvnLRBGi0ycV0T9LfwWvoA528vgRprluQ8rE0LwYCj4CQtCBAUY8wMil5jAtaZhSylrgChMI11VJP2ckGwkLRkLCoFuECpMFe0lwSpWb/bHeTGzEciEcaSQ/bushSZ6C/ZrEiERYcNBXIc1UZobEhkQslG8q3kgD625NYiEY4+ttJRKbIZKk+J8GGtGD0zrhGJoJVVpiSRBdfybVFTgyLbiAZXsmkbkT1N00SEtWUh3TY5ObFlOWwsK5qk22Tvgp9L+9U8eNhmup2yXm+N9uQZe5qm/Of4UX1bFOT9rFWwz6ZIYi5JB8ajtUoW8WJ861loc98Bk99SEdPuWE2QnUlHvlVhgEPnkAOWgRr/z/LdMb/uHumDk7oSSUwNhuHJPnZh60ler05vLaeky/uXKbg1BDlRzGiDUv0H+ZzoeX8wKkzDqmxt9Be7cjZ5MjmNP6yicISByvPwKTUHodP09MnJJD1Jf7iePMvOfsyePhulafq7SMSqidH01VhiiFEGGdTwu7XlN7CzvQvre7ikgFL5oUB/I7bbwaHUSmr6sCvzD1zi24g4+1SxX5mGQs38syQdYOmMrhKwitATBLcGrFBqUBjIPfp6XUDOGff5PH6ZZ59LwVmafpjsk/D0fhIu9QKVLCN7X5s56W8b6dB86MzfLwPZgeK9OAp2eN4F6alonQzrSPOrE7TypLvPbqbMgZxYw/Ohom4uhFpkYnw8LTy5xW5UtE6JTNQhWJ+Nx2jtyFgeU5VWmHvu5TFaOV5wP95F+4CV1NXJZ6WmB6evOLFd7o5cPxCmla+IGbPPzBDVD5GasGTy3/L3zEThPl9vLOkrWemY7cVE3B3p70gVpiEe3KEm2MH/+uPPKFGaom1Ih1gMj+BN6yBOe54WqEuYKVpJHtQMRqXMcr8HeMJGkfdqDVIHqhwGglJWMqACzgrXeoEWc6kklw/DTDflBxXoR/CuplCT46vvHO8VJS1IcdWBMmbOeoIBbINpoo3eZ1gaN5+xSwkg5K2XmrwHT7QTIV2jLgh2b5GAcYAaSAdy1klPgLJh8Mw4oNlMFpIVc+U4XoIa1FgRG0uA/eYsdCsOeXAmb30Ab1QbA2GLDVHoQtREpR/BL7z7xMD5sGM9KqFqWUUChSkJ+tbhMHQJOfkAls3LgqJSH9AFULQgF2svvuSsVQqs4Z6WqHizGr4tKwoOtee50zm0e5p9+qwzvBhEGyWuR/Bev9dMU9B64gJQUs999l6fwM2+zN5R7mWg6fe7flgul/f64PGxzIUMdZuDI2sOclU8jF0zFN9/PBaJCOQa/2Z2RW4hC+qb8AGb4wge90zHc4TZqpvs3GPP7wow6yhZkPY04KXzi7evYQFPRqlIBp3/Lxwev7588fLXq5esl5mm67/JKB2lcTMwPjSoB6YuKOy37Z6kjnp3c+Ds/+Fm3rNXoFUYW4UysnhM2KZn4JujfX2aiNr4wMebTY6efnNqu+XjbkVmXi6lZ9uHJXlO68FKv0DVss3Iyg9g+937AJ3yh5OMjfMi2bEpG+xkzouC7NDAvQF5NGUuXl6LRGDLMQ5ZfB5ZvP+Hte+u9Hqg+5jeOwf4N8f0SYGf+Klf0frnPby7eVCgj2+H5peZbrfbvwFDgtZW",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"}},g={},f=[{value:"Request",id:"request",level:2}];function v(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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Contact list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,l.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,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.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,l.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,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.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,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink