mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-22 17:44:55 +02:00
1 line
9.9 KiB
JavaScript
1 line
9.9 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),c=s.n(n),r=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaWZtIu3u7K8fG6L+XWUm2HCelKceBsaXZeeZt5xnPFhxfWohv4ZOSjqfOwiKADG1qhHZCSYjhpkB2gY51Guzs+pLxslRPlm1UzZxiBp0RuEKWoeOitIwnqnaMM6sxFblIWdpixxCA0mg4mb7MIIYluu4MAtDc8AodGopoC5JXCDF05/cigwAERaS5K+B5mCp5wNRdZkzlbG/S4LdaGMwgdqbGAKzblGTUikqXCAHgWpcqQ4hzXlpSSAusOMRbcBvtNZ0RcgkB5MpU3A0luObeSgz690lSpNNCJ9A0C3JrtZIWLRmaRhH9HIZr6zRFa/O6ZLuKQOCTRelIn2tditQfhA+WQNvj6NqsqXaGzDjRuuyL8eY8iklSrKcPGpoAvvr6v83Ag0KWIBL8vOKi/B/4BPFjJxinqiJT14WSbw5lNjmdTP2HTKQGucPszL1kZg+aRtPT0SQaRT/fTD7Es1/i9x/GURT9DQGsK59N15UZdz5LJ1w5fK919gP8NM/Vuo7vCDgE9FxoGkLNotlxL/bMlsqxXNUy++n7dSIao8y/1+IF980gASFLIfG+p9T9LJrdT3fpvD9O51KueCkyP6hu1CPKH5vO0L1r3R/fl2iV/DkcJDuUt0laTGsj3MYPxfWIazFqz+PbBQ2bCl2humHqp6grIIawu/hwux+gDZA1s+onbG1KiKFwTts4DK3jSyGXI671WGmUVixlyRNLLAy5FuFqAuSvj2dONWvLchDVrjhci8+4gaBPeqjVjfICeYbGF0jIXHlwV4orjXIultIXcjU5Gvg3hbBMWH+cqbSuUDp/qSxXhj1Ds4RbzJiSzBXoD0l+Op7s/qM8dMzu5J2cqwpZbZGGcynko43v5IjdXuW5SAUv2V+YWOFw8a6v3NPT01HFTjzmQriiTphBrfbqSy/0ZR2idi8nEIBDU9mrfI5mJVLsbukVV6FXDrsuJ7JTp7bjtxd9fA6iritFitLioC/PLq6/sNNxBMGgOf5DyOGXy0/nX+fnZJXaq72iyTgaRyTSyrqKy4GjwUbx/Ga3e7J+7+Wja0yHaxfqkgvPPZ/otuPNLeyXh3iweiwCKJR1pLDdUjP9acqmIfG3Gg1xcxHAihvBE+re2y1kwtJztlstXk3y3R/dlnLCXt5iXgy7J5kkhq14WdMbBPCIm8OtqVk0QU80CqxVOEtT1G4APRqLB7Pl4vwGAuA11WhI8EdP8O6BrL8Y1iHz2wDouwleAfxKF/0ZN7/t1NuTVwFdfr02lWjRNM0/jcuuPg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaWZtIu3u7K8fG6L+XWUm2HCelKceBsaXZeeZt5xnPFhxfWohv4ZOSjqfOwiKADG1qhHZCSYjhpkB2gY51Guzs+pLxslRPlm1UzZxiBp0RuEKWoeOitIwnqnaMM6sxFblIWdpixxCA0mg4mb7MIIYluu4MAtDc8AodGopoC5JXCDF05/cigwAERaS5K+B5mCp5wNRdZkzlbG/S4LdaGMwgdqbGAKzblGTUikqXCAHgWpcqQ4hzXlpSSAusOMRbcBvtNZ0RcgkB5MpU3A0luObeSgz690lSpNNCJ9A0C3JrtZIWLRmaRhH9HIZr6zRFa/O6ZLuKQOCTRelIn2tditQfhA+WQNvj6NqsqXaGzDjRuuyL8eY8iklSrKcPGpoAvvr6v83Ag0KWIBL8vOKi/B/4BPFjJxinqiJT14WSbw5lNjmdTP2HTKQGucPszL1kZg+aRtPT0SQaRT/fTD7Es1/i9x/GURT9DQGsK59N15UZdz5LJ1w5fK919gP8NM/Vuo7vCDgE9FxoGkLNotlxL/bMlsqxXNUy++n7dSIao8y/1+IF980gASFLIfG+p9T9LJrdT3fpvD9O51KueCkyP6hu1CPKH5vO0L1r3R/fl2iV/DkcJDuUt0laTGsj3MYPxfWIazFqz+PbBQ2bCl2humHqp6grIIawu/hwux+gDZA1s+onbG1KiKFwTts4DK3jSyGXI671WGmUVixlyRNLLAy5FuFqAuSvj2dONWvLchDVrjhci8+4gaBPeqjVjfICeYbGF0jIXHlwV4orjXIultIXcjU5Gvg3hbBMWH+cqbSuUDp/qSxXhj1Ds4RbzJiSzBXoD0l+Op7s/qM8dMzu5J2cqwpZbZGGcynko43v5IjdXuW5SAUv2V+YWOFw8a6v3NPT01HFTjzmQriiTphBrfbqSy/0ZR2idi8nEIBDU9mrfI5mJVLsbukVV6FXDrsuJ7JTp7bjtxd9fA6iritFitLioC/PLq6/sNNxBMGgOf5DyOGXy0/nX+fnZJXaq72iyTgaRyTSyrqKy4GjwUbx/Ga3e7J+7+Wja0yHaxfqkgvPPZ/otuPNLeyXh3iweiwCKJR1pLDdUjP9acqmIfG3Gg1xcxHAihvBE+re2y1kwtJztlstXk3y3R/dlnLCXt5iXgy7J5kkhq14WdMbBPCIm8OtqVk0QU80CqxVOEtT1G4APRqLB7Pl4vwGAuA11WhI8EdP8O6BrL8Y1iHz2wDouwleAfxKF/0ZN7/t1NuTVwFdfr02lWjRNM0/jcuuPg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Contact"})}),"\n",(0,t.jsx)(c(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); |