mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-11 04:07:40 +02:00
1 line
7.5 KiB
JavaScript
1 line
7.5 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1381],{47091:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>h,default:()=>v,frontMatter:()=>b,metadata:()=>n,toc:()=>g});const n=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/tkaKLacph2mXw2KIAsWrEWTosBSo6CkY4kxRbIk5QsMAfuxN9gb7NH6JMOhJFvOpVu2ohgQJBF5rt+5csM8LxxLrtkrrTzPvGPTiOXoMiuMF1qxhF2VCN0tXAjn4eTNOWBl9BKtg7WuwWuw6K3ABQIHSTR6BlknMQJj9ULkQhXAIdOVsViicmKBsBC4JFouJfAFF5KnErecIBTJt/1BqvV8xCKmDVpO1p3nLGHdJallETPc8go9WvJqwxSvkCVMikrQrSCHPtVo1yxiFj/VwmLOkhmXDiPm/FoS9UzbikUMV0bqHFnibU23WYkVZ8mGVXwlqrpiyfM4jphfG2JSdZWiZQ3x8cqQoEncRFsT3FyYr2bBwzrjZkpyndHKoSPaozimP/tBdXWWoXOzWsIWTRYFLFF5oufGSJGFi/GNI6bNXQN0eoNZgN2SGC9alRZdLf2AjlvLyWHhsXJ/z98eU3S3lM5boQoWBWi4H55sfWemnKTl6ujGECQt7o8TcKMRUsSAaMWF/Bf8KeLL7mCU6YpEmVKrR5tyPHk2OQo/JCKzyD3mJ/4+MTumo/jo2eEkPox/uJq8SI5/TJ6/GMVx/CuL2KoK3nTZmHMfvPTCy+F3bfJvoKe5TdbVcI6eC+mGDN0Na5rBoVBSKPzYp/lHSvEmUBzfl+yXukJfUv9ZovKwtFoVERiJ3CF4uwZecKFAco/2yderArRW2y/j+DjLvgTBcRx/nGxBeH4XhHO14FLkoXtf6Tmqb+vpUL1v1d9NA9EShXu25+zwvHXSYVZb4dehza8OuRGH7X1yPaUeSMBqmg8FtnPBlyxh4/1p4dAu+lFRW8kSVnpvXDIeO67yVK9G2tCoKpTkqaN6HnMjxguqydsc3JhHUGN9+DgG53khVPFlrukOl0uKXRuePXR2PdmIn5Gacgf+kKqbUyXynOZLQ98zHZi7kLw2qC5FoUJAFxN2e2t4jzLTFdJu4EuEnvzz738GjlxndYXKh3x78kF9UK9rC2GnoJnEVQ4ziStB68B9+4ZDXkl0Tq5BKI+F5R4hF4XwXAJBQzWVccNTIQWlKZHpdpsYZLobwfsSfYmWrr6ztL/kuEBJ2Q289rrinkT19sJS2/lM6qWLgENaO6HQOUBVcpURYQ9/BNoCV4DKozVWOATnLVktWtu08pZWqoorXiDJjvZQylEKyk2wOq2dB6dlHUwG6pHaYg69QwoxdyMC8ZQWBovQLk3DTauoRY4ugkznCC5UJbmgckjReTBki8jQkdBaSZ3NQ9xmtZRgNDUJwSWtakMbid1brhwNstaWPgZbwIzVtGlga+DBwTuHFOELoeYuOTj4oA7heptM7zF1wuP0+z7rl8vlnWx/us9zJvxPdQpv0WgnvLbrHXchfFmnoUKGQrYfraQzVBjyZ1ABOxm5ztzdgqPTcYnSjC/RU4a48cmb89BXn8Ln3/6AC+RWQamXbbZmtUW5hqJXRci1kW9h27ZFmOmQeCUhnrXJR2siOk8I0oDdr+b9srM4Q0vgh0Du1BnRib/uzQSy/r+4GdaSbjrTDGj3JWorL2/LCb0cbeVezy7RLkSGXWN7IMLjQDxmEZMiQ+VwMCNOzt5cwAKejWIWDVrkP4j2+OL81ekvl6dkDVVWi9hkFI/isKVp5yuuBqrO0G9fPt3A2EN7s5uf/8NXUtfmPa782EguwkQNgG26aXi993aaRqzUztPxZpNyh++sbBo6bp8rNCNz4Uj37sEyx/XgebXgsiadYXw9QNu9g3akU/qwgmjD7I76sUMKW56TLEMzVHBnWdmb+GenVyxiVET7424exl33D0nvr9R6IHt/DrYG0G/y6V6GzaYdpU2zpW+vHuToHOypKTTTpmn+AjCWahc=","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 i=o(74848),a=o(28453),s=o(33617),r=o.n(s),c=o(17543),l=o.n(c),p=o(86013),d=o.n(p),m=o(63723),u=o.n(m),k=(o(18766),o(79329),o(9303));const b={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/tkaKLacph2mXw2KIAsWrEWTosBSo6CkY4kxRbIk5QsMAfuxN9gb7NH6JMOhJFvOpVu2ohgQJBF5rt+5csM8LxxLrtkrrTzPvGPTiOXoMiuMF1qxhF2VCN0tXAjn4eTNOWBl9BKtg7WuwWuw6K3ABQIHSTR6BlknMQJj9ULkQhXAIdOVsViicmKBsBC4JFouJfAFF5KnErecIBTJt/1BqvV8xCKmDVpO1p3nLGHdJallETPc8go9WvJqwxSvkCVMikrQrSCHPtVo1yxiFj/VwmLOkhmXDiPm/FoS9UzbikUMV0bqHFnibU23WYkVZ8mGVXwlqrpiyfM4jphfG2JSdZWiZQ3x8cqQoEncRFsT3FyYr2bBwzrjZkpyndHKoSPaozimP/tBdXWWoXOzWsIWTRYFLFF5oufGSJGFi/GNI6bNXQN0eoNZgN2SGC9alRZdLf2AjlvLyWHhsXJ/z98eU3S3lM5boQoWBWi4H55sfWemnKTl6ujGECQt7o8TcKMRUsSAaMWF/Bf8KeLL7mCU6YpEmVKrR5tyPHk2OQo/JCKzyD3mJ/4+MTumo/jo2eEkPox/uJq8SI5/TJ6/GMVx/CuL2KoK3nTZmHMfvPTCy+F3bfJvoKe5TdbVcI6eC+mGDN0Na5rBoVBSKPzYp/lHSvEmUBzfl+yXukJfUv9ZovKwtFoVERiJ3CF4uwZecKFAco/2yderArRW2y/j+DjLvgTBcRx/nGxBeH4XhHO14FLkoXtf6Tmqb+vpUL1v1d9NA9EShXu25+zwvHXSYVZb4dehza8OuRGH7X1yPaUeSMBqmg8FtnPBlyxh4/1p4dAu+lFRW8kSVnpvXDIeO67yVK9G2tCoKpTkqaN6HnMjxguqydsc3JhHUGN9+DgG53khVPFlrukOl0uKXRuePXR2PdmIn5Gacgf+kKqbUyXynOZLQ98zHZi7kLw2qC5FoUJAFxN2e2t4jzLTFdJu4EuEnvzz738GjlxndYXKh3x78kF9UK9rC2GnoJnEVQ4ziStB68B9+4ZDXkl0Tq5BKI+F5R4hF4XwXAJBQzWVccNTIQWlKZHpdpsYZLobwfsSfYmWrr6ztL/kuEBJ2Q289rrinkT19sJS2/lM6qWLgENaO6HQOUBVcpURYQ9/BNoCV4DKozVWOATnLVktWtu08pZWqoorXiDJjvZQylEKyk2wOq2dB6dlHUwG6pHaYg69QwoxdyMC8ZQWBovQLk3DTauoRY4ugkznCC5UJbmgckjReTBki8jQkdBaSZ3NQ9xmtZRgNDUJwSWtakMbid1brhwNstaWPgZbwIzVtGlga+DBwTuHFOELoeYuOTj4oA7heptM7zF1wuP0+z7rl8vlnWx/us9zJvxPdQpv0WgnvLbrHXchfFmnoUKGQrYfraQzVBjyZ1ABOxm5ztzdgqPTcYnSjC/RU4a48cmb89BXn8Ln3/6AC+RWQamXbbZmtUW5hqJXRci1kW9h27ZFmOmQeCUhnrXJR2siOk8I0oDdr+b9srM4Q0vgh0Du1BnRib/uzQSy/r+4GdaSbjrTDGj3JWorL2/LCb0cbeVezy7RLkSGXWN7IMLjQDxmEZMiQ+VwMCNOzt5cwAKejWIWDVrkP4j2+OL81ekvl6dkDVVWi9hkFI/isKVp5yuuBqrO0G9fPt3A2EN7s5uf/8NXUtfmPa782EguwkQNgG26aXi993aaRqzUztPxZpNyh++sbBo6bp8rNCNz4Uj37sEyx/XgebXgsiadYXw9QNu9g3akU/qwgmjD7I76sUMKW56TLEMzVHBnWdmb+GenVyxiVET7424exl33D0nvr9R6IHt/DrYG0G/y6V6GzaYdpU2zpW+vHuToHOypKTTTpmn+AjCWahc=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,y={},g=[];function x(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,i.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,i.jsx)(k.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.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,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.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(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(x,{...e})}):x(e)}}}]); |