mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-29 04:54:56 +02:00
1 line
7.3 KiB
JavaScript
1 line
7.3 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1381],{47091:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>N,frontMatter:()=>h,metadata:()=>o,toc:()=>v});const o=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzNV9tu20YQ/ZXJvrQBaIlyLkX5FCMNDKNBE8AuAtQRgiE5Itda7m53l7pA4Fu/pJ/WLylmScmUHad1EQQFDNvaud/OjHYiYOVFdi1eGx2wCF7ME1GSL5y0QRotMnFVEwxUeCt9gLP3F0CNNWtyHramhWDAUXCSVgQIinnMAopBYwLWmZUspa4AoTCNdVST9nJFsJK0Zl5UCnCFUmGu6CAJUrN+t3/IjVlORCKMJYfs3UUpMjEQ2axIhEWHDQVyHNVOaGxIZELJRjJVckC/t+S2IhGOfm+lo1JkC1SeEuHDVjH3wrhGJII2VpmSRBZcy9SipgZFthMNbmTTNiJ7kaaJCFvLQrptcnKiYzlsLCuapV1ycMEvpf1qHjxsM+3mrNdboz155j1NU/5zXFTfFgV5v2gVHLIpkphL0oH50Voli0iY3ngW2t13wOQ3VMS0O1YTZG/SkW9VGPGhc8gBy0CN/2f5/pmre+D0wUldiSSmBsP45RC7sPUsrzenN5ZT0uf9cQpuDEFOFDPaoFT/QT4nejU8TArTsCpbG/1oV57Pns1O4w+rKBxhoPIsfE7NrdBpevrsZJaepD9czV5mz3/MXrycpGn6m0jEponRDN1YYohRBhnU+HNry29gp7vLNsxwSQGl8mOBgSK6bvQotZKaPu3b/BO3eBc5nn+u2S9NQ6Fm/FmTDrB2RlcJWEXoCYLbAlYoNSgM5J58vSkg54z7ch4f59mXUvA8TT/NDkl4cT8JF3qFSpYRva/MkvS3jXRsPvTm77eB7JkiXRwFO37vg/RUtE6GbYT5zQlaedLTs+s5YyAn1vB+qKjfC6EWmZgebwtPbrVfFa1TIhN1CNZn06lHXeZmMzGWV1WlFeae53mKVk5XPJN3JdDaR3BTe/I4AR+wkrr6stT8Ni+XXLu+PEfZucVkK38mBuUh+WOuYU/VhCXvl44/L0wUHkryzpK+lJWOBV3NxN2r4QOpwjTEt0GoCfbsf/3xZ5QoTdE2pEPstyfwrnUQDwpeSKhLWCjaSL4FmBmVMuvDqeEJG0Xeqy1IHahyGAhKWcmACjgrPE4FWsylktyhzGb6Q2LU5H4CH2oKNTkmfef4dClpRYobG5QxS9YTDGAbTBNtDD7D2rjlgl1KACFvvdTkPXiivQjpGnVBsK9FAsYBaiAdyFknPQHKhpkXxgEtFrKQrJib0/Gd1aDGithYAuw3Z6G/osiDM3nrA3ij2hgIW2yIQh+iJir9BH7i8yoGzo89sFIJVcsqEihMSTBMJ4ehS8jJB7BsXhYUlfqALoCiFbnYe7GSi1YpsIZhQ6Li421cW1YUHGrPq613aF+aQ/qsM3x7RBslbifwUX/UjITQeuIGUFIvffZRn8D1oc0+UO5loPn3+3lYr9f35uDpscy5DHWbgyNrbuWq+BinZix++PBUJCKQa/y7xSW5lSxoGMIHbE4j83QAU15VDIj98cAz9uquAAObkgVpTyPoOzt//xZW8GySimQ0+f/C4enbi9dvfrl8w3oZzPr5m03SSRqPD+NDg3pk6pzC4aAfcPBodne3a+F/ePwP6BVoE6ZWoYyLIiZsN4D89dFXgnkiauMDP+92OXr61amu4+f+CmfoL6Vn27d3+JK2o28NK1Qt24yo/ADvcN7fss75g5PMG1dSskdTNtjLnBUF2bGBezv4aJGdv7kSicCWYxyj+DKi+PAPa9+T9Hak+xjeewf4N8f0WYHdrt8QXXfg70kPSgwB7rm5NPOu6/4GaUj7CQ==","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":"Self Sign","permalink":"/docs/API-docs/selfsign"}}');var a=i(74848),n=i(28453),s=i(33617),r=i.n(s),l=i(17543),c=i.n(l),p=i(86013),m=i.n(p),d=i(63723),u=i.n(d),f=(i(18766),i(79329),i(9303));const h={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:"eJzNV9tu20YQ/ZXJvrQBaIlyLkX5FCMNDKNBE8AuAtQRgiE5Itda7m53l7pA4Fu/pJ/WLylmScmUHad1EQQFDNvaud/OjHYiYOVFdi1eGx2wCF7ME1GSL5y0QRotMnFVEwxUeCt9gLP3F0CNNWtyHramhWDAUXCSVgQIinnMAopBYwLWmZUspa4AoTCNdVST9nJFsJK0Zl5UCnCFUmGu6CAJUrN+t3/IjVlORCKMJYfs3UUpMjEQ2axIhEWHDQVyHNVOaGxIZELJRjJVckC/t+S2IhGOfm+lo1JkC1SeEuHDVjH3wrhGJII2VpmSRBZcy9SipgZFthMNbmTTNiJ7kaaJCFvLQrptcnKiYzlsLCuapV1ycMEvpf1qHjxsM+3mrNdboz155j1NU/5zXFTfFgV5v2gVHLIpkphL0oH50Voli0iY3ngW2t13wOQ3VMS0O1YTZG/SkW9VGPGhc8gBy0CN/2f5/pmre+D0wUldiSSmBsP45RC7sPUsrzenN5ZT0uf9cQpuDEFOFDPaoFT/QT4nejU8TArTsCpbG/1oV57Pns1O4w+rKBxhoPIsfE7NrdBpevrsZJaepD9czV5mz3/MXrycpGn6m0jEponRDN1YYohRBhnU+HNry29gp7vLNsxwSQGl8mOBgSK6bvQotZKaPu3b/BO3eBc5nn+u2S9NQ6Fm/FmTDrB2RlcJWEXoCYLbAlYoNSgM5J58vSkg54z7ch4f59mXUvA8TT/NDkl4cT8JF3qFSpYRva/MkvS3jXRsPvTm77eB7JkiXRwFO37vg/RUtE6GbYT5zQlaedLTs+s5YyAn1vB+qKjfC6EWmZgebwtPbrVfFa1TIhN1CNZn06lHXeZmMzGWV1WlFeae53mKVk5XPJN3JdDaR3BTe/I4AR+wkrr6stT8Ni+XXLu+PEfZucVkK38mBuUh+WOuYU/VhCXvl44/L0wUHkryzpK+lJWOBV3NxN2r4QOpwjTEt0GoCfbsf/3xZ5QoTdE2pEPstyfwrnUQDwpeSKhLWCjaSL4FmBmVMuvDqeEJG0Xeqy1IHahyGAhKWcmACjgrPE4FWsylktyhzGb6Q2LU5H4CH2oKNTkmfef4dClpRYobG5QxS9YTDGAbTBNtDD7D2rjlgl1KACFvvdTkPXiivQjpGnVBsK9FAsYBaiAdyFknPQHKhpkXxgEtFrKQrJib0/Gd1aDGithYAuw3Z6G/osiDM3nrA3ij2hgIW2yIQh+iJir9BH7i8yoGzo89sFIJVcsqEihMSTBMJ4ehS8jJB7BsXhYUlfqALoCiFbnYe7GSi1YpsIZhQ6Li421cW1YUHGrPq613aF+aQ/qsM3x7RBslbifwUX/UjITQeuIGUFIvffZRn8D1oc0+UO5loPn3+3lYr9f35uDpscy5DHWbgyNrbuWq+BinZix++PBUJCKQa/y7xSW5lSxoGMIHbE4j83QAU15VDIj98cAz9uquAAObkgVpTyPoOzt//xZW8GySimQ0+f/C4enbi9dvfrl8w3oZzPr5m03SSRqPD+NDg3pk6pzC4aAfcPBodne3a+F/ePwP6BVoE6ZWoYyLIiZsN4D89dFXgnkiauMDP+92OXr61amu4+f+CmfoL6Vn27d3+JK2o28NK1Qt24yo/ADvcN7fss75g5PMG1dSskdTNtjLnBUF2bGBezv4aJGdv7kSicCWYxyj+DKi+PAPa9+T9Hak+xjeewf4N8f0WYHdrt8QXXfg70kPSgwB7rm5NPOu6/4GaUj7CQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,g={},v=[];function C(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,a.jsx)(t.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,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(c(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,a.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}},title:"inline_response_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function N(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(C,{...e})}):C(e)}}}]); |