mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-11 12:17:41 +02:00
1 line
8.3 KiB
JavaScript
1 line
8.3 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>V,contentTitle:()=>g,default:()=>T,frontMatter:()=>u,metadata:()=>i,toc:()=>x});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":"eJzNV9tu5LgR/ZUKX5JtyH3xzGwQPa0xGDhGjB0j9sJAPMaAkqoluimSS5a63Wg0sA/5gzzlNZ82XxIUdWm17dmNk8UigGFbxbpfWIc7QbIMIr0T760hmVMQ94koMOReOVLWiFTcVAjdKVyqQHB2dQFYO7tBH2BrGyALHskrXCNI0Mxjl5B3GhNw3q5VoUwJEnJbO48VmqDWCGuFG+aVWoNcS6VlpnGQBGVYv+8JmbWrqUiEdegle3dRiFR0h2xWJMJJL2sk9BzVThhZo0iFVrXiU8UB/dig34pEePyxUR4LkS6lDpiIQFvN3Evra5EIfHTaFihS8g2f5hXWUqQ7UctHVTe1SN/N54mgrWMh09QZerFnOVk7VrSY75PBhbBS7lfz4Os25/t71hucNQED857O5/znuKihyXMMYdloGLIpkphLNMT80jmt8ngwewgstHvugM0eMI9p96yGVGvSY2g0jfik95IDVoR1+GX5lszVHTgDeWVKkcTUSBpThtiFqxZZ9Xj64Dglbd5fp+DBImSIMaO1VPq/kM8Qv+sI09zWrMpV1rzalbeLN4vT+MMqeGyk2b5WiXU8aKVhFQ82+0yK9Ks9KXAdXfAoCYszekn+wH06P31zspifzP94s/g2ffun9N230/l8/jeRiMc6JrQbiEJSTHTn0/DduOI3sLN/ytZdIwWSVDqMBboTsd+PiMpoZfBzP2mfecr2kePtS/N2bWukiq/ADRqCjbemTMBplAGB/BZkKZUBLQn97369QUTvrf/5PL7Os59Lwdv5/PNiSMK750m4MGupVREXyI1dofltIx2bp9b88zZQLVM8F0fBjultkAHzxivaxk3zeCKdOmnP07t7voY5sZZXVIntaqJKpGJ2vLAC+nW/rRqvRSoqIhfS2SxIU2T2cdoPsZZZ4CtlJp2arRdTvhieykjnXsWPzclrRQLJUpnyl+TuD/m55hq2ZTrK0mE9OPUX5P3QFWHM1a3MCmXBq27P30sbhbvSfHRorlVpYmGj8acQ5hZ1bmtkoEIVwmTSi3z5+78GqckECps3NRqKLTj9ZD6Zj42HiHR4U0pTwFLjo2KQ8hIKCihrjSHoLShDWHpJCIUqFUkNnCces1w6mSmtuHOZzbYYZ9T8YQq3FVKFno9+7xlVFbhGzQ0PsiFbS2JVvb+wsX611HYTEpCQNUEZDAHQVNLkzNhXIgHrQRpAQ+idVwEhkGevVeubNeQZ6NXSyBJZdwLjZBWoFbcreJs1gSBY3USXga9N67GAPiCDWISYxA8MYzxCC+XG+K9sVIEhgdwWCCEOKodgCsgwEDj2ReUYWGljtM1XsYDLRmtwlu8NJTUDyLGPLE5emsBLrfWlr8GQMOct4x9sHZxMfgjIFb5UZhXSyeSTOYG7oa9uMQuK8P4P/QhsNptnrf/Nscy5oj83GfwVnQ2KrN8epEtFVZPFcRkrGT5aTedoMPbPaBgOOgqbh+fTx9RZhdrNrpG4Q8Ls7OoiXrXfwJef/gGXKL2Bym7abs0bj3oLZW+KM9dWvk3bcFPC0sbGqzjjedt8DF4xUJ/B20rSl5/+GeB73DBwb0eKQ5lMrppMqxxusHa8R8JkksL7CCeAehpQJQlyaSBDCJXkVlorCRJcK62VWU3hzGyhCehho6iKzcD0KHcUBudlKHeATAYswJoo0ducHjxieh1QrzGwLmOJ3cBCEXd05W1TttbGznTBeVwqreFWFSVSjO2sKMB15E1L5oSP3MElDwRVuAXpEQIamsLVE5F40jhnPXuhWueXVmu74QKgKZxVhkIKhZdLOuhPDo0eUZuy5gVSm0I5pCPp1AwlaSexi3igTj/xpfzkIj++bz0u0bPBGPahLk517XTXtyVwt/4vbd2C4xagMQxoUTtvlO+e6onrHH0dPi6v0a9Vjt1W+8pEzyLzTCRCqxxNwBFMODu/uoT1m+lcJKP1+B8M9+zy4v2H768/sDN8kbYJW0zn03l8KthAtTQjS+dIw/O7gwxHyd4dENT/4VO9W/CEjzRzWqqIqWLCdh0eujt6wN8norKBmLzb8dD+4PV+z+T2zcwoqVCBbR9ezSvcjt74a6kbthmhy1d4u8f4gfWeP7xi3ojekh5wsMFW5izP0Y0NPIOrR5jv/MONSATfmcdAZxWBTvcPa++PzHak+xgBtQ7wb47pRYHdrgVR+/3A3x59VaILsOfm0tzv9/t/A7ATTaM=","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 s=o(74848),a=o(28453),n=o(33617),r=o.n(n),l=o(17543),c=o.n(l),p=o(86013),d=o.n(p),m=o(63723),h=o.n(m),b=(o(18766),o(79329),o(9303));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:"eJzNV9tu5LgR/ZUKX5JtyH3xzGwQPa0xGDhGjB0j9sJAPMaAkqoluimSS5a63Wg0sA/5gzzlNZ82XxIUdWm17dmNk8UigGFbxbpfWIc7QbIMIr0T760hmVMQ94koMOReOVLWiFTcVAjdKVyqQHB2dQFYO7tBH2BrGyALHskrXCNI0Mxjl5B3GhNw3q5VoUwJEnJbO48VmqDWCGuFG+aVWoNcS6VlpnGQBGVYv+8JmbWrqUiEdegle3dRiFR0h2xWJMJJL2sk9BzVThhZo0iFVrXiU8UB/dig34pEePyxUR4LkS6lDpiIQFvN3Evra5EIfHTaFihS8g2f5hXWUqQ7UctHVTe1SN/N54mgrWMh09QZerFnOVk7VrSY75PBhbBS7lfz4Os25/t71hucNQED857O5/znuKihyXMMYdloGLIpkphLNMT80jmt8ngwewgstHvugM0eMI9p96yGVGvSY2g0jfik95IDVoR1+GX5lszVHTgDeWVKkcTUSBpThtiFqxZZ9Xj64Dglbd5fp+DBImSIMaO1VPq/kM8Qv+sI09zWrMpV1rzalbeLN4vT+MMqeGyk2b5WiXU8aKVhFQ82+0yK9Ks9KXAdXfAoCYszekn+wH06P31zspifzP94s/g2ffun9N230/l8/jeRiMc6JrQbiEJSTHTn0/DduOI3sLN/ytZdIwWSVDqMBboTsd+PiMpoZfBzP2mfecr2kePtS/N2bWukiq/ADRqCjbemTMBplAGB/BZkKZUBLQn97369QUTvrf/5PL7Os59Lwdv5/PNiSMK750m4MGupVREXyI1dofltIx2bp9b88zZQLVM8F0fBjultkAHzxivaxk3zeCKdOmnP07t7voY5sZZXVIntaqJKpGJ2vLAC+nW/rRqvRSoqIhfS2SxIU2T2cdoPsZZZ4CtlJp2arRdTvhieykjnXsWPzclrRQLJUpnyl+TuD/m55hq2ZTrK0mE9OPUX5P3QFWHM1a3MCmXBq27P30sbhbvSfHRorlVpYmGj8acQ5hZ1bmtkoEIVwmTSi3z5+78GqckECps3NRqKLTj9ZD6Zj42HiHR4U0pTwFLjo2KQ8hIKCihrjSHoLShDWHpJCIUqFUkNnCces1w6mSmtuHOZzbYYZ9T8YQq3FVKFno9+7xlVFbhGzQ0PsiFbS2JVvb+wsX611HYTEpCQNUEZDAHQVNLkzNhXIgHrQRpAQ+idVwEhkGevVeubNeQZ6NXSyBJZdwLjZBWoFbcreJs1gSBY3USXga9N67GAPiCDWISYxA8MYzxCC+XG+K9sVIEhgdwWCCEOKodgCsgwEDj2ReUYWGljtM1XsYDLRmtwlu8NJTUDyLGPLE5emsBLrfWlr8GQMOct4x9sHZxMfgjIFb5UZhXSyeSTOYG7oa9uMQuK8P4P/QhsNptnrf/Nscy5oj83GfwVnQ2KrN8epEtFVZPFcRkrGT5aTedoMPbPaBgOOgqbh+fTx9RZhdrNrpG4Q8Ls7OoiXrXfwJef/gGXKL2Bym7abs0bj3oLZW+KM9dWvk3bcFPC0sbGqzjjedt8DF4xUJ/B20rSl5/+GeB73DBwb0eKQ5lMrppMqxxusHa8R8JkksL7CCeAehpQJQlyaSBDCJXkVlorCRJcK62VWU3hzGyhCehho6iKzcD0KHcUBudlKHeATAYswJoo0ducHjxieh1QrzGwLmOJ3cBCEXd05W1TttbGznTBeVwqreFWFSVSjO2sKMB15E1L5oSP3MElDwRVuAXpEQIamsLVE5F40jhnPXuhWueXVmu74QKgKZxVhkIKhZdLOuhPDo0eUZuy5gVSm0I5pCPp1AwlaSexi3igTj/xpfzkIj++bz0u0bPBGPahLk517XTXtyVwt/4vbd2C4xagMQxoUTtvlO+e6onrHH0dPi6v0a9Vjt1W+8pEzyLzTCRCqxxNwBFMODu/uoT1m+lcJKP1+B8M9+zy4v2H768/sDN8kbYJW0zn03l8KthAtTQjS+dIw/O7gwxHyd4dENT/4VO9W/CEjzRzWqqIqWLCdh0eujt6wN8norKBmLzb8dD+4PV+z+T2zcwoqVCBbR9ezSvcjt74a6kbthmhy1d4u8f4gfWeP7xi3ojekh5wsMFW5izP0Y0NPIOrR5jv/MONSATfmcdAZxWBTvcPa++PzHak+xgBtQ7wb47pRYHdrgVR+/3A3x59VaILsOfm0tzv9/t/A7ATTaM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,V={},x=[];function P(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,s.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,s.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,s.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.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,s.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{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 T(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(P,{...e})}):P(e)}}}]); |