mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-27 20:14:53 +02:00
1 line
7.4 KiB
JavaScript
1 line
7.4 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1381],{47091:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>f,contentTitle:()=>g,default:()=>v,frontMatter:()=>x,metadata:()=>a,toc:()=>D});const a=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":"eJzNV+tu2zYUfpVT/tkKKLacph3mXw26IghWrAWSocBSoziSjiXGFMmSlC8w9K9PskfbkwyHkm05abplKIoBQRIdnuvHc+NWBCy9mN6IV0YHzIMXs0QU5HMnbZBGi6m4rgj6U3gjfYDzd5dAtTUrch42poFgwFFwkpYECIp5zBzyXmMC1pmlLKQuASE3tXVUkfZySbCUtGJeVApwiVJhpmgvCVKzfrcjZMYsRiIRxpJD9u6yEFPRH7JZkQiLDmsK5DiqrdBYk5gKJWvJp5ID+tSQ24hEOPrUSEeFmM5ReUqEDxvF3HPjapEIWltlChLT4Bo+zSuqUUy3osa1rJtaTJ+naSLCxrKQbuqMnGhZDmvLiiZpm+xd8Atpv5kHD9tM2xnr9dZoT555T9OU/xxfqm/ynLyfNwr2aIokYkk6MD9aq2QeD8a3noW29x0w2S3lEXbHaoLsTDryjQoDPnQOOWAZqPb/LN+R+Xb3nD44qUuRRGgwDCn72IWtJlm1Pr21DEmH++MU3BqCjCgiWqNU/0E+I3rZE0a5qVmVrYx+tCtnk2eT0/jDKnJHGKg4D19ScxA6TU+fnUzSk/Sn68mL6dnP0+cvRmma/iESsa5jNH02FhhilEEGNfxubPEd7LR32foaLiigVH4o0J+Ith0QpVZS08ddmn/kFG8jx9mXkv3K1BQq7j8r0gFWzugyAasIPUFwG8ASpQaFgdyTb1cF5JxxX8fxcZ59DYKzNP042YPw/D4Il3qJShaxe1+bBenvG+nQfOjM308D2THFc3EU7JDeBekpb5wMm9jm1ydo5Ul3Pr2ZcQ9kYA3Ph5K6uRAqMRXj42nhyS13o6JxSkxFFYL10/HYoy4ysx4Zy6Oq1Aozz/U8RivHS67JuxJo7SO4qTl5nIAPWEpdfl1qdsDliu+uu54jdA492cpfiZtyD/6Qq59TFWHB86Xl77mJwv2VvLWkr2Sp44UuJ+Lu1vCeVG5q4t0gVAQ79r8+/xklCpM3NekQ8+0JvG0cxIWCBxLqAuaK1pJ3AWZGpcxqv2p4wlqR92oDUgcqHQaCQpYyoAJGhcspR4uZVJIzlNlMt0gMktyP4H1FoSLHRz84Xl0KWpLixAZlzIL1BAPYBFNHG73PsDJuMWeXEkDIGi81eQ+eaCdCukKdE+zuIgHjADWQDuSsk54AZc3Mc+OA5nOZS1bMyel4z6pRY0lsLAH2m1Hotijy4EzW+ADeqCYGwhZrotCFqIkKP4JfeL2KgTOxa6xUQNmwigRyUxD01clh6AIy8gEsm5c5RaU+oAugaEku5l68yXmjFFjDbUOi4uVteLesKDjUnkdb59DuavbwWWd494g2CtyM4IP+oLkTQuOJE0BJvfDTD/oEbvZp9p4yLwPNftzVw2q1ulcHT49lLmSomgwcWXOQKyMxVs1QfP/xlGfYccEcZ7ajOTmOJmJUkqaYgWhl19jg5vzdZeywUJGyB8sscr90mTpmxvEVhSB16cc7+adx8vcDkNtst5Jw5b68qye2S3K1fzu/IreUOfW94wGoxpF5LBKhZE7a06ANn1+8ewNLeDZKRTLoQv8CvPGby1evf7t6zd5wY+0Qm4zSURoXIeNDjXpg6oLC/nHR9+QjtLeHEfU/fIj0nTTQOoytQhmHVgRs2w+cm6PnySwRlfGBydtthp5+d6ptmdy9CHgMFdKz7cObYEGbwQtmiaphm3FCPMDbPzUOrDP+cJJ543hMdp2dDXYy53lOdmjg3j5wNFQvXl+LRGDDMQ4nyiJOlP4f1r470puB7uNR0znAvzmmLwpst920ats9f3f0oEQf4I6br2bWtu3faIYtTg==","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 n=o(74848),i=o(28453),s=o(33617),c=o.n(s),l=o(17543),p=o.n(l),r=o(86013),m=o.n(r),d=o(63723),u=o.n(d),y=(o(18766),o(79329),o(9303));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:"eJzNV+tu2zYUfpVT/tkKKLacph3mXw26IghWrAWSocBSoziSjiXGFMmSlC8w9K9PskfbkwyHkm05abplKIoBQRIdnuvHc+NWBCy9mN6IV0YHzIMXs0QU5HMnbZBGi6m4rgj6U3gjfYDzd5dAtTUrch42poFgwFFwkpYECIp5zBzyXmMC1pmlLKQuASE3tXVUkfZySbCUtGJeVApwiVJhpmgvCVKzfrcjZMYsRiIRxpJD9u6yEFPRH7JZkQiLDmsK5DiqrdBYk5gKJWvJp5ID+tSQ24hEOPrUSEeFmM5ReUqEDxvF3HPjapEIWltlChLT4Bo+zSuqUUy3osa1rJtaTJ+naSLCxrKQbuqMnGhZDmvLiiZpm+xd8Atpv5kHD9tM2xnr9dZoT555T9OU/xxfqm/ynLyfNwr2aIokYkk6MD9aq2QeD8a3noW29x0w2S3lEXbHaoLsTDryjQoDPnQOOWAZqPb/LN+R+Xb3nD44qUuRRGgwDCn72IWtJlm1Pr21DEmH++MU3BqCjCgiWqNU/0E+I3rZE0a5qVmVrYx+tCtnk2eT0/jDKnJHGKg4D19ScxA6TU+fnUzSk/Sn68mL6dnP0+cvRmma/iESsa5jNH02FhhilEEGNfxubPEd7LR32foaLiigVH4o0J+Ith0QpVZS08ddmn/kFG8jx9mXkv3K1BQq7j8r0gFWzugyAasIPUFwG8ASpQaFgdyTb1cF5JxxX8fxcZ59DYKzNP042YPw/D4Il3qJShaxe1+bBenvG+nQfOjM308D2THFc3EU7JDeBekpb5wMm9jm1ydo5Ul3Pr2ZcQ9kYA3Ph5K6uRAqMRXj42nhyS13o6JxSkxFFYL10/HYoy4ysx4Zy6Oq1Aozz/U8RivHS67JuxJo7SO4qTl5nIAPWEpdfl1qdsDliu+uu54jdA492cpfiZtyD/6Qq59TFWHB86Xl77mJwv2VvLWkr2Sp44UuJ+Lu1vCeVG5q4t0gVAQ79r8+/xklCpM3NekQ8+0JvG0cxIWCBxLqAuaK1pJ3AWZGpcxqv2p4wlqR92oDUgcqHQaCQpYyoAJGhcspR4uZVJIzlNlMt0gMktyP4H1FoSLHRz84Xl0KWpLixAZlzIL1BAPYBFNHG73PsDJuMWeXEkDIGi81eQ+eaCdCukKdE+zuIgHjADWQDuSsk54AZc3Mc+OA5nOZS1bMyel4z6pRY0lsLAH2m1Hotijy4EzW+ADeqCYGwhZrotCFqIkKP4JfeL2KgTOxa6xUQNmwigRyUxD01clh6AIy8gEsm5c5RaU+oAugaEku5l68yXmjFFjDbUOi4uVteLesKDjUnkdb59DuavbwWWd494g2CtyM4IP+oLkTQuOJE0BJvfDTD/oEbvZp9p4yLwPNftzVw2q1ulcHT49lLmSomgwcWXOQKyMxVs1QfP/xlGfYccEcZ7ajOTmOJmJUkqaYgWhl19jg5vzdZeywUJGyB8sscr90mTpmxvEVhSB16cc7+adx8vcDkNtst5Jw5b68qye2S3K1fzu/IreUOfW94wGoxpF5LBKhZE7a06ANn1+8ewNLeDZKRTLoQv8CvPGby1evf7t6zd5wY+0Qm4zSURoXIeNDjXpg6oLC/nHR9+QjtLeHEfU/fIj0nTTQOoytQhmHVgRs2w+cm6PnySwRlfGBydtthp5+d6ptmdy9CHgMFdKz7cObYEGbwQtmiaphm3FCPMDbPzUOrDP+cJJ543hMdp2dDXYy53lOdmjg3j5wNFQvXl+LRGDDMQ4nyiJOlP4f1r470puB7uNR0znAvzmmLwpst920ats9f3f0oEQf4I6br2bWtu3faIYtTg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,f={},D=[];function h(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,n.jsx)(c(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,n.jsx)(e.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)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(p(),{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)(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 v(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,n.jsx)(e,{...t,children:(0,n.jsx)(h,{...t})}):h(t)}}}]); |