https://www.zeyos.com/assets/js/243bdd55.f909c61a.js

1"use strict";(self.webpackChunkdevcenter=self.webpackChunkdevcenter||[]).push([["15773"],{27752(e,t,a){a.r(t),a.d(t,{metadata:()=>n,default:()=>v,frontMatter:()=>u,contentTitle:()=>x,toc:()=>I,assets:()=>j});var n=JSON.parse('{"id":"get-address","title":"Get address","description":"Return the data of an existing address by **`ID`**. Requires `accounts` permission. Has dependency on `account`.","source":"@site/restapi-content/get-address.api.mdx","sourceDirName":".","slug":"/get-address","permalink":"/api/get-address","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-address","title":"Get address","description":"Return the data of an existing address by **`ID`**. Requires `accounts` permission. Has dependency on `account`.","sidebar_label":"Get address","hide_title":true,"hide_table_of_contents":true,"api":"eJzFWP9P4zoS/1fm/KQ7WoV+p0BOSMcrXTZaFhAFre4B2rjJhPqR2FnbAfqq/O8nO2mb0rKwy57eT5Wb8cx85svHY8+IpneKuNeEhqFEpVCRW4eEqALJUs0EJy65QJ1JDnqCEFJNQURAOeATU5rxOyh3wngK9brvHfn1egMu8FvGJCrwaRCIjGvlQ4oyYUoxwRvwkSoIMUUeIg+mIPhC0G8Qh4gUJTXmvZC45A71YWGEOCSlkiaoURq3Z4TTBIlLvCPiEGa8TameEIfIwoGQuFpm+BzSFWffMgS7SwUTTChxZ0RPU6OLcY13KEmeOwv9+JRSHs5tfMtQTslzpUMrA4HgGrk2YQpEkgrFNELEMA4VbPl/KsF9B3wqJZ36ICT4Y8YjFqNf2+SMlSMOyazHnsZEzSGxYrEQVVoyfkdyh+ATTdIYTV6t4a/GKnHKxVxlsSqtk9sqXC/a/ixCFjEMt0eMBzhHPkEaolyDXpaI0lRnCgIRoqmFbqvn1+vwOEEOMVUaklInKKMTtq4vPgxgt9Pt3G5NtE6V22xqIWLVYKijhpB3zYlO4qaMAiP0m8LA2NvuNnq1jcEqI+CQSMiEauKSkGrc1iwxABZRIR8kc6CzD4fZHbT393ehteu2e26rBcefL8mzQJwKjtufqQ4m7wmC4JAYHaZjkGump6Dp3TtC0HklBEu0N2S3G+xEYdjejdp7rajT7vT393f6/f54F8Oghd0bQvL81jSNSgU3JODOSKfVMj+rGM8+EafEb4WGl/RuXWr4foCdRvdXA3TICVV6Udjrbp8sazSw7GP4DsE0tSmhJZb2j2J5LVnvrNfcISXrGOU0TeMSQNM2vjtbNy3Gf2KgDZ9KQ7aaFUn3jjYQYcU/xnW/t1b5JTsXfLpwu23ckki1kK8q7XaIQ3gWx3Rstm7i7EGhCjKFErwj2AoxolmsFWgBNNMT01YB1RgWIoKDtc4Er1Xd6s/dYoKbcP8M4EG5/1mBUAUUrq84e7JrpWmSLksFeeOR3bMUQ0ZtsZhV00h/NdK1VURBJqU5RlYtvARqb7ez193b67VyhxiqTSpF/qPgXmuD96KkmRbbEhVqy4oVQy9CKmeDt5XRs9osttqKqdeXM0e9vmJtt+whGvyUlUGx9XkHdHOnVLVBJfIsIe51y2k7Hafr9Jwdp2+HL1sExG291GZGE2z5Lf/gd+/kxDs9/jr66J2fe6fHDvjt5b/lrwN+xz84vzgbXF0MPw9PL6vi3dUvyy09/2BwdnIyHFx6Z6cO+DsVa8OTk+GFA37/mVr7f81MIAsQ38X9XbRHxReIhAQ9YWoxaFqFhvM005Yel7Nrbrmw2+qtk/up0LCg/twhvVZ7XeiKGyIRkv2F4epB9+XLl+3DCsms7z2XGKGUGFbJyHSP5d7K6bHzltNjZ3F69BrtN5+EvyOVKEEijZODGzLzTkeXh6eDYX5DAKUU8uCGMP5AYxZ+1eIeuT0YV48PjU+6mcaUbT44NlitRs0Fr9AP48IXa6ZMTK/VXY/bByHHLAzRDKjvcmOhyIUTGtzbu0kQmIpZ3jwWjrxQIR9Exm157Gyafi4ybhlwaEIJWx7XKDmNYYTyAWXxd+29MDygCdBIUhaCBwHl/9IQCtATquGIPuA/LIbcIQnqiSjvR/ZipCfEJc1FNzRn3lFuCsd6V1yXMhmbAbYsvyAWWdj4C6dCNQKRNJf10qQpaz6013juD5yejWBg9hGHPFDJzIFdjA7l3iJsZVeTEBNhHL41fgSZZHpqHRGmZIh7fWuG7aJGyoXCIlNmWdk1sl1kLZV7l7OMWa9z8pnpV+g0WnBYlmfRj0Uj9nd7+682ohGq1f5tBgp7/63Xr4sIVHSfe0s1IT5gbOYpVYlq4V4N/POz0SWUy+ZDu2lhm8uBFiDGmjIOFDY0j0OiWDxa6LSKZCBCXPvz6q0ZXvqx6F7iFKn4CR1zTyVGEtXkHRpUIFKb56LKy9pYJNvonLOhWReRWkv+x8vLcyjp8HCVj+f532m9If87rZo90BZVubyZp+wTmnt0eVX8Y/jfs9HyHSIQ4p7hml+jQg8M7OcXXOv0Xz8jjJBxLTf2ImEdK8/DokRHmvKQyhAuhqNLU6YmuygTdRYZvmIBVjL0+PhYyY8VE5EqxVYmozlaa+M4GX+Ef8JANODTsXmlWEn7ilLDcQllsR0FIvGf5YfcIYafivg8tM06FUonlFfsHaOeDwDPYzpb8u3f8VZVlkOF6PMyELOSk6uvaw5xvSPzxjYRSptPs9mYKryScZ6bv4unJcOQIVOGW0PiRjRWz69DVdC/4uFpI4p7nFbfvh5onBkhYnh5zv0/6OtWGe2wBtVHuI3m543Gp1Xjc7e8I5Lf5vMh7Qfd+HserL4T5E0vbst4O78M2//pHer7yFae0FZQFSKHQYCprnxbe8IwFbeYd46H5tHjf3qAnAU=","sidebar_class_name":"get api-method","info_path":"api//zeyos-standard-rest-api","custom_edit_url":null},"sidebar":"restapiSidebar","previous":{"title":"Create new address","permalink":"/api/create-address"},"next":{"title":"Check if address exists","permalink":"/api/exists-address"}}'),s=a(74848),i=a(28453),r=a(80258),d=a(15866),o=a.n(d),l=a(18192),c=a.n(l),p=a(11258),m=a.n(p);a(63795),a(57250);var h=a(72072),f=a(30568);let u={id:"get-address",title:"Get address",description:"Return the data of an existing address by **`ID`**. Requires `accounts` permission. Has dependency on `account`.",sidebar_label:"Get address",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWP9P4zoS/1fm/KQ7WoV+p0BOSMcrXTZaFhAFre4B2rjJhPqR2FnbAfqq/O8nO2mb0rKwy57eT5Wb8cx85svHY8+IpneKuNeEhqFEpVCRW4eEqALJUs0EJy65QJ1JDnqCEFJNQURAOeATU5rxOyh3wngK9brvHfn1egMu8FvGJCrwaRCIjGvlQ4oyYUoxwRvwkSoIMUUeIg+mIPhC0G8Qh4gUJTXmvZC45A71YWGEOCSlkiaoURq3Z4TTBIlLvCPiEGa8TameEIfIwoGQuFpm+BzSFWffMgS7SwUTTChxZ0RPU6OLcY13KEmeOwv9+JRSHs5tfMtQTslzpUMrA4HgGrk2YQpEkgrFNELEMA4VbPl/KsF9B3wqJZ36ICT4Y8YjFqNf2+SMlSMOyazHnsZEzSGxYrEQVVoyfkdyh+ATTdIYTV6t4a/GKnHKxVxlsSqtk9sqXC/a/ixCFjEMt0eMBzhHPkEaolyDXpaI0lRnCgIRoqmFbqvn1+vwOEEOMVUaklInKKMTtq4vPgxgt9Pt3G5NtE6V22xqIWLVYKijhpB3zYlO4qaMAiP0m8LA2NvuNnq1jcEqI+CQSMiEauKSkGrc1iwxABZRIR8kc6CzD4fZHbT393ehteu2e26rBcefL8mzQJwKjtufqQ4m7wmC4JAYHaZjkGump6Dp3TtC0HklBEu0N2S3G+xEYdje

1jdp7rajT7vT393f6/f54F8Oghd0bQvL81jSNSgU3JODOSKfVMj+rGM8+EafEb4WGl/RuXWr4foCdRvdXA3TICVV6Udjrbp8sazSw7GP4DsE0tSmhJZb2j2J5LVnvrNfcISXrGOU0TeMSQNM2vjtbNy3Gf2KgDZ9KQ7aaFUn3jjYQYcU/xnW/t1b5JTsXfLpwu23ckki1kK8q7XaIQ3gWx3Rstm7i7EGhCjKFErwj2AoxolmsFWgBNNMT01YB1RgWIoKDtc4Er1Xd6s/dYoKbcP8M4EG5/1mBUAUUrq84e7JrpWmSLksFeeOR3bMUQ0ZtsZhV00h/NdK1VURBJqU5RlYtvARqb7ez193b67VyhxiqTSpF/qPgXmuD96KkmRbbEhVqy4oVQy9CKmeDt5XRs9osttqKqdeXM0e9vmJtt+whGvyUlUGx9XkHdHOnVLVBJfIsIe51y2k7Hafr9Jwdp2+HL1sExG291GZGE2z5Lf/gd+/kxDs9/jr66J2fe6fHDvjt5b/lrwN+xz84vzgbXF0MPw9PL6vi3dUvyy09/2BwdnIyHFx6Z6cO+DsVa8OTk+GFA37/mVr7f81MIAsQ38X9XbRHxReIhAQ9YWoxaFqFhvM005Yel7Nrbrmw2+qtk/up0LCg/twhvVZ7XeiKGyIRkv2F4epB9+XLl+3DCsms7z2XGKGUGFbJyHSP5d7K6bHzltNjZ3F69BrtN5+EvyOVKEEijZODGzLzTkeXh6eDYX5DAKUU8uCGMP5AYxZ+1eIeuT0YV48PjU+6mcaUbT44NlitRs0Fr9AP48IXa6ZMTK/VXY/bByHHLAzRDKjvcmOhyIUTGtzbu0kQmIpZ3jwWjrxQIR9Exm157Gyafi4ybhlwaEIJWx7XKDmNYYTyAWXxd+29MDygCdBIUhaCBwHl/9IQCtATquGIPuA/LIbcIQnqiSjvR/ZipCfEJc1FNzRn3lFuCsd6V1yXMhmbAbYsvyAWWdj4C6dCNQKRNJf10qQpaz6013juD5yejWBg9hGHPFDJzIFdjA7l3iJsZVeTEBNhHL41fgSZZHpqHRGmZIh7fWuG7aJGyoXCIlNmWdk1sl1kLZV7l7OMWa9z8pnpV+g0WnBYlmfRj0Uj9nd7+682ohGq1f5tBgp7/63Xr4sIVHSfe0s1IT5gbOYpVYlq4V4N/POz0SWUy+ZDu2lhm8uBFiDGmjIOFDY0j0OiWDxa6LSKZCBCXPvz6q0ZXvqx6F7iFKn4CR1zTyVGEtXkHRpUIFKb56LKy9pYJNvonLOhWReRWkv+x8vLcyjp8HCVj+f532m9If87rZo90BZVubyZp+wTmnt0eVX8Y/jfs9HyHSIQ4p7hml+jQg8M7OcXXOv0Xz8jjJBxLTf2ImEdK8/DokRHmvKQyhAuhqNLU6YmuygTdRYZvmIBVjL0+PhYyY8VE5EqxVYmozlaa+M4GX+Ef8JANODTsXmlWEn7ilLDcQllsR0FIvGf5YfcIYafivg8tM06FUonlFfsHaOeDwDPYzpb8u3f8VZVlkOF6PMyELOSk6uvaw5xvSPzxjYRSptPs9mYKryScZ6bv4unJcOQIVOGW0PiRjRWz69DVdC/4uFpI4p7nFbfvh5onBkhYnh5zv0/6OtWGe2wBtVHuI3m543Gp1Xjc7e8I5Lf5vMh7Qfd+HserL4T5E0vbst4O78M2//pHer7yFae0FZQFSKHQYCprnxbe8IwFbeYd46H5tHjf3qAnAU=",sidebar_class_name:"get api-method",info_path:"api//zeyos-standard-rest-api",custom_edit_url:null},x,j={},I=[];function y(e){let t={code:"code",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get address"}),"\n",(0,s.jsx)(r.A,{method:"get",path:"/addresses/{ID}",context:"endpoint"}),"\n",(0,s.jsxs)(t.p,{children:["Return the data of an existing address by ",(0,s.jsx)(t.strong,{children:(0,s.jsx)(t.code,{children:"ID"})}),". Requires ",(0,s.jsx)(t.code,{children:"accounts"})," permission. Has dependency on ",(0,s.jsx)(t.code,{children:"account"}),"."]}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(o(),{parameters:[{name:"ID",in:"path",required:!0,description:"Unique ID",schema:{type:"integer"}},{name:"expand",in:"query",description:"Expand content of composite fields (`json`, `array` or `binfile`)",schema:{type:"array",uniqueItems:!0,items:{type:"string"},example:["field_json","field_array","field_binfile"]}},{name:"If-Modified-Since",in:"header",description:"Return status code **`304`** when last modified since ([RFC 7232](https://tools.ietf.org/html/rfc7232#section-3.4))",schema:{type:"string",format:"date-time",example:"Fri, 29 Aug 1997 07:14:00 GMT"}},{name:"If-None-Match",in:"header",description:"Return status code **`304`** on matching entity tag ([RFC 7232](https://tools.ietf.org/html/rfc7232#section-3.2))",schema:{type:"string",example:'"73c5fdd17f180f2126995666b7edc0e3"'}}]}),"\n",(0,s.jsx)(c(),{title:"Body"}),"\n",(0,s.jsx)(m(),{responses:{200:{description:"OK",headers:{ETag:{description:"Entity tag ([RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3))",schema:{type:"string",example:'"73c5fdd17f180f2126995666b7edc0e3"'}},"Last-Modified":{description:"Last modification date and time ([RFC 7231](https://tools.ietf.org/html/rfc7232#section-2.2))",schema:{type:"string",format:"date-time",example:"Fri, 29 Aug 1997 07:14:00 GMT"}}},content:{"application/json":{schema:{type:"object",properties:{ID:{type:"integer",format:"int64",description:"Address ID",example:1},creator:{type:"integer",format:"int32",nullable:!0,description:"Creator user ID (defaults to authenticated user on creation)",example:6},creationdate:{type:"integer",format:"int64",description:"Creation date and time as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) (defaults to current date and time on creation)",example:0x340676b8},lastmodified:{type:"integer",format:"int64",description:"Last modification date and time as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) (auto-reset on modification)",example:0x340676b8},account:{type:"integer",format:"int32",description:"Account ID (**dependency**)",example:7},contact:{type:"integer",format:"int32",description:"Contact ID",example:13},type:{type:"integer",enum:[0,1,2,3,4,5,6],default:0,description:"Address type (`0`=BILLING_SHIPPING, `1`=BILLING_BILLING, `2`=PROCUREMENT_SHIPPING, `3`=PROCUREMENT_BILLING, `4`=COLLECTION, `5`=BILLING_SELLER, `6`=PROCUREMENT_SELLER)"},default:{type:"integer",enum:[0,1],default:0,description:"Default for this address type"}},title:"addresses"}}}},304:{description:"Not Modified"},401:{description:"Unauthorized",headers:{"WWW-Authenticate":{description:"Preferred authentication scheme ([RFC 7235](https://tools.ietf.org/html/rfc7235#section-4.1))",schema:{type:"string",example:'Bearer realm="{INSTANCE}" error="invalid_token"'}}},content:{"text/plain":{schema:{type:"string",example:"Unauthorized: Invalid bearer token"}}}}

1,403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string",example:"Forbidden: Lacking access permission"}}}},404:{description:"Not Found"},500:{description:"Runtime Error (Internal Server Error)",content:{"text/plain":{schema:{type:"string",example:"I am afraid I can't do that Dave!"}}}}}})]})}function v(e={}){let{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}},14694(e,t,a){a.d(t,{A:()=>p});var n=a(74848);a(96540);var s=a(34164),i=a(88287);let r={admonition:"admonition_WFEd",admonitionHeader:"admonitionHeader_Bavf",statusDot:"statusDot_FpPs",pulse:"pulse_yBRw",admonitionIcon:"admonitionIcon_y8oN",admonitionTitle:"admonitionTitle_QtC5",admonitionContent:"admonitionContent_rZj0",note:"note_jCa_",tip:"tip_pnV7",info:"info_aPJR",warning:"warning_QpOk",danger:"danger_pSq0"},d={note:{label:"NOTE",variantClass:"note"},tip:{label:"TIP",variantClass:"tip"},info:{label:"INFO",variantClass:"info"},caution:{label:"CAUTION",variantClass:"warning"},warning:{label:"WARNING",variantClass:"warning"},danger:{label:"DANGER",variantClass:"danger"}};function o({type:e,className:t,children:a}){let l=d[e]||d.note;return(0,n.jsx)("div",{className:(0,s.A)(i.G.common.admonition,i.G.common.admonitionType(e),r.admonition,r[l.variantClass],t),role:"note","aria-label":l.label,children:a})}function l({type:e,icon:t,title:a}){let s=d[e]||d.note;return(0,n.jsxs)("div",{className:r.admonitionHeader,children:[(0,n.jsx)("span",{className:r.statusDot,"aria-hidden":"true"}),(0,n.jsx)("span",{className:r.admonitionIcon,children:t}),(0,n.jsx)("span",{className:r.admonitionTitle,children:a||s.label})]})}function c({children:e}){return e?(0,n.jsx)("div",{className:r.admonitionContent,children:e}):null}function p(e){let{type:t,icon:a,title:s,children:i,className:r}=e;return(0,n.jsxs)(o,{type:t,className:r,children:[(0,n.jsx)(l,{type:t,title:s,icon:a}),(0,n.jsx)(c,{children:i})]})}},80258(e,t,a){a.d(t,{A:()=>o});var n=a(74848);a(96540);var s=a(9526),i=a(49361);function r(e){switch(e.toLowerCase()){case"get":return"primary";case"post":return"success";case"delete":return"danger";case"put":return"info";case"patch":return"warning";case"head":case"event":return"secondary";default:return}}function d({method:e,path:t}){let a=(0,i.useTypedSelector)(e=>e.server.value),s=function(e){if(!e)return"";try{let t=e.replace(/\/\{[^}]+\}/g,"");return new URL(t).pathname.replace(/\/$/,"")}catch{return""}}(a?.url),o=t.replace(/{([a-z0-9-_]+)}/gi,":$1");return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)("pre",{className:"openapi__method-endpoint",children:[(0,n.jsx)("span",{className:"badge badge--"+r(e),children:"event"===e?"Webhook":e.toUpperCase()})," ","event"!==e&&(0,n.jsxs)("h2",{className:"openapi__method-endpoint-path",children:[s,o]})]}),(0,n.jsx)("div",{className:"openapi__divider"})]})}let o=function({method:e,path:t}){let a=t.replace(/{([a-z0-9-_]+)}/gi,":$1");return(0,n.jsx)(s.default,{fallback:(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)("pre",{className:"openapi__method-endpoint",children:[(0,n.jsx)("span",{className:"badge badge--"+r(e),children:"event"===e?"Webhook":e.toUpperCase()})," ","event"!==e&&(0,n.jsx)("h2",{className:"openapi__method-endpoint-path",children:a})]}),(0,n.jsx)("div",{className:"openapi__divider"})]}),children:()=>(0,n.jsx)(d,{method:e,path:t})})}},26496(e,t,a){a.d(t,{A:()=>h});var n=a(74848);a(96540);var s=a(34164),i=a(71643),r=a(66697),d=a(64560),o=a(47819);let l="dot_y3mg",c={js:"JavaScript",javascript:"JavaScript",ts:"TypeScript",typescript:"TypeScript",jsx:"JSX",tsx:"TSX",py:"Python",python:"Python",rb:"Ruby",ruby:"Ruby",go:"Go",rust:"Rust",java:"Java",cpp:"C++",c:"C",cs:"C#",csharp:"C#",php:"PHP",swift:"Swift",kotlin:"Kotlin",sql:"SQL",bash:"Bash",shell:"Shell",sh:"Shell",zsh:"Zsh",powershell:"PowerShell",json:"JSON",yaml:"YAML",yml:"YAML",xml:"XML",html:"HTML",css:"CSS",scss:"SCSS",sass:"Sass",less:"Less",md:"Markdown",markdown:"Markdown",mdx:"MDX",graphql:"GraphQL",docker:"Docker",dockerfile:"Dockerfile",nginx:"Nginx",apache:"Apache",diff:"Diff",text:"Text",txt:"Text",plaintext:"Plain Text"};function p(){return(0,n.jsxs)("div",{className:"terminalDots_SIqA","aria-hidden":"true",children:[(0,n.jsx)("span",{className:l,"data-color":"red"}),(0,n.jsx)("span",{className:l,"data-color":"yellow"}),(0,n.jsx)("span",{className:l,"data-color":"green"})]})}function m({title:e,language:t}){let a=e||(t?c[t.toLowerCase()]||t.toUpperCase():null);return(0,n.jsxs)("div",{className:"terminalHeader_EONi",children:[(0,n.jsx)(p,{}),a&&(0,n.jsx)("span",{className:"terminalTitle_k0HC",children:a})]})}function h({className:e}){let{metadata:t}=(0,i.Ph)();return(0,n.jsxs)(r.A,{as:"div",className:(0,s.A)("codeBlockWrapper_yrsB",e,t.className),children:[(0,n.jsx)(m,{title:t.title,language:t.language}),(0,n.jsxs)("div",{className:"codeBlockContent_jWiz",children:[(0,n.jsx)(d.A,{}),(0,n.jsx)(o.A,{})]})]})}}}]);