mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-27 20:14:53 +02:00
1 line
8.5 KiB
JavaScript
1 line
8.5 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>I,contentTitle:()=>f,default:()=>j,frontMatter:()=>v,metadata:()=>i,toc:()=>F});const i=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/contactlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/contactlist","permalink":"/docs/API-docs/v1.1/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":"eJzNWF9v47gR/ypTvrRnKP6T3b2ifrpgsUiDbneDSw4Bmg0WlDSWGFMkjxzZMQwD99Bv0Ke+9qPtJymGlGw5yd417eFQIEii4cxw/s9P2gqSVRDzW/HWGpIFBXGXiRJD4ZUjZY2Yi+saoTuF9yoQnF1eADbOrtEH2NgWyIJH8gpXCBI089gFFJ3GDJy3K1UqU4GEwjbOY40mqBXCSuGaeaXWIFdSaZlr3EuCMqzf94Tc2uVYZMI69JKtuyjFXHSHfK3IhJNeNkjo2autMLJBMRdaNYpPFTv0Y4t+IzLh8cdWeSzFfCF1wEwE2mjmXljfiEzgg9O2RDEn3/JpUWMjxXwrGvmgmrYR8zfTaSZo41jItE2OXuxYTjaOFc2mu2xvQlgq96tZ8PU7p7s71hucNQED855Op/znOKmhLQoMYdFq2EdTZDGWaIj5pXNaFfFgch9YaPvUAJvfYxHD7lkNqXSlx9BqGvBJ7yU7rAib8MvyiczZ3XMG8spUIouhkTSk7H0Xrp7l9cPpveOQpLi/TMG9RcgRY0QbqfR/IZ8jftcRxoVtWJWrrXmxKa9nr2an8YdVcNtIs3mpEuu40SrDKu5t/pkU6RdbUuIqmuBREpZn9Jz8gft0evrqZDY9mf7xevbt/PWf5m++HU+n07+JTDw0MaBdQ5SSYqA7m/bPrSt/g3t2j9m6MVIiSaXDUKA7EbvdgKiMVgY/9532mbtsFzleP9dvV7ZBqnkErtEQrL01VQZOowwI5DcgK6kMaEnof/frNSJ6b/3Px/Fllv1cCF5Pp59n+yC8eRqEC7OSWpVxgVzbJZrf1tPh9ZSuf1oGKjHFc3Hk7JCenAxYtF7RJm6ahxPp1Ek6n9/e8RjmwFpeURWm1US1mIvJ8cIK6Ff9tnpUM2tZVej/3ObR5LOWLPzVFsvkV+u1mIuayIX5ZLJSnpKmcUhidZvz/Jlcerlotf4gV0vpJzwQJrPxdDwVvJuOlQRpytw+jPupoWUeog7p1GQ1G8+ekZHOvYgf25OXigSSlTLVL8ndHRJyxUWT6uIoLYd95NRfkBdSl/UhV7eja5Ql79YdPy9sFO5q4aNDc6UqE9MSL3+MmW5QF7ZBRkZUI4xGvciXv/9rLzUaQWmLtkFDsebHn8wn87H1EKEVr2ZpSlhofFCMip6DXQFlozEEvQFlCCsvCaFUlSKpgePEfV1IJ3OlFbcKs9kEqgbdFsZwUyPV6Pno955hXIkr1NxhIFuyjSRW1dsLa+uXC23XIQMJeRuUwRAATS1NwYx9JjKwHqQBNITeeRUQAnm2WiXbrCHPyLKRRlbIujMYBqtErbg/wNu8DQTB6jaaDDynrccSeocMYhliEN8xbvIICTsOAWfVqhJDBoUtEUKcDOyCKSHHQODYFlVgYKWt0bZYxgRyB4GzPKiU1IxYhzayOHlpAm/RZEufg33AnLcMuDAZOBr9EJAz/F6ZZZiPRp/MCdzu6+oG86AI7/7Qt8B6vX5S+t8cy5wr4knxPTobFFm/OUhXivppMFSyf0iaztFgrJ9BMxx0lLYIT7uPqZMatZtcIXGFhMnZ5UWc7d/Al5/+Ae9RegO1XadqLVqPegNVfxVHLmU+hW0/mmFhY+HVHPEiFR+jZQzUR/CmlvTlp38G+IBrflNILcWujEaXba5VAdfYOF5cYTSaw9uIX4B6GlAtCQppIEcIteRSWikJElyS1sosx3BmNtAG9LBWVMdiYHqUO3KD47JPd4BcBizBmijR3zk+WMT0JqBeYWBdxhKbgaUiruja27ZKtw2N6ZzzuFBaw40qK6To21lZguvI60TmgA/MwQU3BNW4AekRAhoaw+UjkXjSOmc9W6GS8QurtV1zAtCUzipDYQ6llws66M8OhR5horLmGVIKodyHI+vU7FOSOrHzeE8df+Kh/GiQH89bjwv0fGF0+5AXp7pyuu3LErha/5eyTmg8IULGHek1gTfKd4/1RPyAvgkfF1foV6rAbqt9paMnkXkiMqFVgSbgAJecnV++h9Wr8fRo9f8HzT15f/H23Yerd2wMD9IUsB4CCGcDNdIMbjpH2r/vdxjlKNjbA2T7P/w20C14wgeaOC1VBHExYNsOgN0efTG4y0RtAzF5u+Wm/cHr3Y7J6SU9wjIV+O7Da/oSN4OPCiupW74zQpev8HZv/wfWO37winkjXMx6wMEXJpmzokA3vOAJPj4CmefvrkUmeGYeA51lBDrdP6y9PzKbge5jBJQM4N/s07MC220CUbvdnj8dfVWic7Dn5tTc7Xa7fwNscHVO","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"}}');var n=a(74848),o=a(28453),r=a(33617),s=a.n(r),c=a(17543),l=a.n(c),p=a(86013),m=a.n(p),d=a(63723),g=a.n(d),u=(a(18766),a(79329),a(9303));const v={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:"eJzNWF9v47gR/ypTvrRnKP6T3b2ifrpgsUiDbneDSw4Bmg0WlDSWGFMkjxzZMQwD99Bv0Ke+9qPtJymGlGw5yd417eFQIEii4cxw/s9P2gqSVRDzW/HWGpIFBXGXiRJD4ZUjZY2Yi+saoTuF9yoQnF1eADbOrtEH2NgWyIJH8gpXCBI089gFFJ3GDJy3K1UqU4GEwjbOY40mqBXCSuGaeaXWIFdSaZlr3EuCMqzf94Tc2uVYZMI69JKtuyjFXHSHfK3IhJNeNkjo2autMLJBMRdaNYpPFTv0Y4t+IzLh8cdWeSzFfCF1wEwE2mjmXljfiEzgg9O2RDEn3/JpUWMjxXwrGvmgmrYR8zfTaSZo41jItE2OXuxYTjaOFc2mu2xvQlgq96tZ8PU7p7s71hucNQED855Op/znOKmhLQoMYdFq2EdTZDGWaIj5pXNaFfFgch9YaPvUAJvfYxHD7lkNqXSlx9BqGvBJ7yU7rAib8MvyiczZ3XMG8spUIouhkTSk7H0Xrp7l9cPpveOQpLi/TMG9RcgRY0QbqfR/IZ8jftcRxoVtWJWrrXmxKa9nr2an8YdVcNtIs3mpEuu40SrDKu5t/pkU6RdbUuIqmuBREpZn9Jz8gft0evrqZDY9mf7xevbt/PWf5m++HU+n07+JTDw0MaBdQ5SSYqA7m/bPrSt/g3t2j9m6MVIiSaXDUKA7EbvdgKiMVgY/9532mbtsFzleP9dvV7ZBqnkErtEQrL01VQZOowwI5DcgK6kMaEnof/frNSJ6b/3Px/Fllv1cCF5Pp59n+yC8eRqEC7OSWpVxgVzbJZrf1tPh9ZSuf1oGKjHFc3Hk7JCenAxYtF7RJm6ahxPp1Ek6n9/e8RjmwFpeURWm1US1mIvJ8cIK6Ff9tnpUM2tZVej/3ObR5LOWLPzVFsvkV+u1mIuayIX5ZLJSnpKmcUhidZvz/Jlcerlotf4gV0vpJzwQJrPxdDwVvJuOlQRpytw+jPupoWUeog7p1GQ1G8+ekZHOvYgf25OXigSSlTLVL8ndHRJyxUWT6uIoLYd95NRfkBdSl/UhV7eja5Ql79YdPy9sFO5q4aNDc6UqE9MSL3+MmW5QF7ZBRkZUI4xGvciXv/9rLzUaQWmLtkFDsebHn8wn87H1EKEVr2ZpSlhofFCMip6DXQFlozEEvQFlCCsvCaFUlSKpgePEfV1IJ3OlFbcKs9kEqgbdFsZwUyPV6Pno955hXIkr1NxhIFuyjSRW1dsLa+uXC23XIQMJeRuUwRAATS1NwYx9JjKwHqQBNITeeRUQAnm2WiXbrCHPyLKRRlbIujMYBqtErbg/wNu8DQTB6jaaDDynrccSeocMYhliEN8xbvIICTsOAWfVqhJDBoUtEUKcDOyCKSHHQODYFlVgYKWt0bZYxgRyB4GzPKiU1IxYhzayOHlpAm/RZEufg33AnLcMuDAZOBr9EJAz/F6ZZZiPRp/MCdzu6+oG86AI7/7Qt8B6vX5S+t8cy5wr4knxPTobFFm/OUhXivppMFSyf0iaztFgrJ9BMxx0lLYIT7uPqZMatZtcIXGFhMnZ5UWc7d/Al5/+Ae9RegO1XadqLVqPegNVfxVHLmU+hW0/mmFhY+HVHPEiFR+jZQzUR/CmlvTlp38G+IBrflNILcWujEaXba5VAdfYOF5cYTSaw9uIX4B6GlAtCQppIEcIteRSWikJElyS1sosx3BmNtAG9LBWVMdiYHqUO3KD47JPd4BcBizBmijR3zk+WMT0JqBeYWBdxhKbgaUiruja27ZKtw2N6ZzzuFBaw40qK6To21lZguvI60TmgA/MwQU3BNW4AekRAhoaw+UjkXjSOmc9W6GS8QurtV1zAtCUzipDYQ6llws66M8OhR5horLmGVIKodyHI+vU7FOSOrHzeE8df+Kh/GiQH89bjwv0fGF0+5AXp7pyuu3LErha/5eyTmg8IULGHek1gTfKd4/1RPyAvgkfF1foV6rAbqt9paMnkXkiMqFVgSbgAJecnV++h9Wr8fRo9f8HzT15f/H23Yerd2wMD9IUsB4CCGcDNdIMbjpH2r/vdxjlKNjbA2T7P/w20C14wgeaOC1VBHExYNsOgN0efTG4y0RtAzF5u+Wm/cHr3Y7J6SU9wjIV+O7Da/oSN4OPCiupW74zQpev8HZv/wfWO37winkjXMx6wMEXJpmzokA3vOAJPj4CmefvrkUmeGYeA51lBDrdP6y9PzKbge5jBJQM4N/s07MC220CUbvdnj8dfVWic7Dn5tTc7Xa7fwNscHVO",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,I={},F=[];function b(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,n.jsx)(s(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,n.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,n.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(l(),{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,n.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(g(),{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"},company:{type:"string",format:"string",example:"opensign"},job_title:{type:"string",format:"string",example:"dev"},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 j(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); |