{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Paperjoy","description":"Dokumentacja Paperjoy: wysyłaj ręcznie pisane pocztówki z edytora, przez Zapier, MCP lub API.","colors":{"primary":"#171717","light":"#FAFAFA","dark":"#171717"},"logo":{"light":"https://mintcdn.com/paperjoy/uLGEyGsDEbQfn2is/logo/light.svg?fit=max\u0026auto=format\u0026n=uLGEyGsDEbQfn2is\u0026q=85\u0026s=f421bce949674ab0c88ab69890f71993","dark":"https://mintcdn.com/paperjoy/uLGEyGsDEbQfn2is/logo/dark.svg?fit=max\u0026auto=format\u0026n=uLGEyGsDEbQfn2is\u0026q=85\u0026s=aa2e2aef22a909e258ab7df213a055bf","href":"https://paperjoy.co"},"favicon":"https://mintcdn.com/paperjoy/F1MJj4Vyrx0MCZIR/logo/mark.svg?fit=max\u0026auto=format\u0026n=F1MJj4Vyrx0MCZIR\u0026q=85\u0026s=1a3fe3abd6a211223f8aae3a2ffdfc6a","appearance":{"default":"light","strict":true},"navbar":{"links":[],"primary":{"type":"button","label":"Open Paperjoy","href":"https://paperjoy.co"}},"footer":{"socials":{}},"seo":{"metatags":{"og:site_name":"Paperjoy Docs","twitter:card":"summary_large_image"},"organization":{"id":"https://paperjoy.co/#organization","name":"Paperjoy","legalName":"Paperjoy Norbert Jurga","url":"https://paperjoy.co/","logo":"https://paperjoy.co/icon-512.png"},"indexing":"navigable"},"fonts":{"family":"Instrument Sans"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view"],"display":"header"},"thumbnails":{"appearance":"light","background":"https://mintcdn.com/paperjoy/dzsHsibbZz8x9Ehv/images/og/background.png?fit=max\u0026auto=format\u0026n=dzsHsibbZz8x9Ehv\u0026q=85\u0026s=0b4fdde338ccfafbc781dd527894cd99"},"navigation":{"global":{"anchors":[{"anchor":"Paperjoy","icon":"house","href":"/"},{"anchor":"API","icon":"square-terminal","href":"/reference/introduction"},{"anchor":"Changelog","icon":"scroll-text","href":"/changelog"}]},"directory":"card","languages":[{"language":"pl","default":true,"navbar":{"links":[],"primary":{"type":"button","label":"Otwórz Paperjoy","href":"https://paperjoy.co"}},"href":""},{"language":"en","navbar":{"links":[],"primary":{"type":"button","label":"Open Paperjoy","href":"https://paperjoy.co"}},"href":"en"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paperjoy","hasAudioNarration":false,"actualSubdomain":"paperjoy","customDomains":["docs.paperjoy.co"],"gitSource":{"type":"github","owner":"norbertjurga","repo":"paperjoy-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae891cab4392014d5240346","collectionId":"3cad2a5c-5ad4-4278-b73e-79c079804298","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae891cab4392014d5240346"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae891cab4392014d5240346","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"pl","tag":"Dokumentacja API","count":14},{"language":"en","tag":"API reference","count":14},{"language":"pl","tag":"Endpointy API","count":11},{"language":"en","tag":"Endpoints","count":11},{"language":"pl","tag":"Pocztówki","count":8},{"language":"en","tag":"Postcards","count":8},{"language":"pl","tag":"Pierwsze kroki","count":5},{"language":"en","tag":"Get started","count":5},{"language":"pl","tag":"Sposoby wysyłki","count":3},{"language":"en","tag":"Ways to send","count":3},{"language":"pl","tag":"Konto","count":1},{"language":"en","tag":"Account","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--default-border-color:var(--gray-200)}.dark{--default-border-color:var(--gray-800)}#sidebar .nav-dropdown-trigger{border:0!important;background:0 0!important;box-shadow:none!important;padding-left:.375rem}#sidebar .nav-dropdown-trigger:hover{background-color:rgb(0 0 0/.04)!important}.dark #sidebar .nav-dropdown-trigger:hover{background-color:rgb(255 255 255/.06)!important}a.bg-primary-dark{background-color:#171717!important;color:#fafafa!important}a.bg-primary-dark *{color:inherit!important}.dark a.bg-primary-dark{background-color:#fafafa!important;color:#171717!important}#sidebar .nav-dropdown-trigger .nav-dropdown-item-icon,.nav-dropdown-content .nav-dropdown-item-icon{border:0!important;background:0 0!important;height:auto!important;width:auto!important;padding:0!important}.nav-dropdown-content .nav-dropdown-item-description{display:none!important}#sidebar .nav-anchor span{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;font-size:12px;font-weight:500;letter-spacing:-.02em;text-transform:uppercase}body:has([data-product-guide-index]) #sidebar a.nav-anchor[href='/']{color:rgb(var(--primary))!important;font-weight:600!important}body:has([data-product-guide-index]) #sidebar a.nav-anchor[href='/'] span{color:inherit!important}body:has([data-product-guide-index]) #sidebar a.nav-anchor[href='/'] svg{background-color:rgb(var(--primary))!important}.dark body:has([data-product-guide-index]) #sidebar a.nav-anchor[href='/']{color:rgb(var(--primary-light)/var(--tw-text-opacity,1))!important}.dark body:has([data-product-guide-index]) #sidebar a.nav-anchor[href='/'] svg{background-color:rgb(var(--primary-light)/var(--tw-text-opacity,1))!important}:is(#content-area[data-current-path='/'], [data-current-path='/'] #content-area):has([data-product-guide-index]){background:0 0!important;padding:0!important}:is(#content-area[data-current-path='/'], [data-current-path='/'] #content-area):has([data-product-guide-index])>div:first-child{background:0 0!important;padding-right:0!important;padding-bottom:0!important;padding-left:0!important}[data-product-guide-index] a:not(.product-guide-feature-card):not(.pj-button){background-color:#fafafa!important}.dark [data-product-guide-index] a:not(.product-guide-feature-card):not(.pj-button){background-color:#09090b!important}.product-guide-feature-card,.product-guide-feature-card>div{display:flex!important;flex-direction:column!important;justify-content:space-between!important}.product-guide-feature-card{grid-column:1/-1;min-height:260px;background:#171717!important;border:0!important;box-shadow:none!important;color:#fff!important}.product-guide-feature-card>div{flex:1}.product-guide-feature-card :is(h2, h3, p, span, svg){color:#fff!important}.product-guide-feature-card :is(svg, [class*='icon']){background-color:#fff!important;width:2em!important;height:2em!important;margin-top:2px}.product-guide-feature-card-title{font-size:1.2em;font-weight:500}.product-guide-feature-card :is(h2, h3, p, span, svg).product-guide-feature-card-description{font-size:1.05em;font-weight:400;color:rgb(var(--gray-50)/82%)!important}.dark .product-guide-feature-card :is(h2, h3, p, span, svg).product-guide-feature-card-description{color:rgb(var(--gray-50)/82%)!important}img.nav-logo{width:104px;height:32px}"}],"page":{"pagePath":"api-reference/postcards/retrieve-a-postcard","slug":"/api-reference/postcards/retrieve-a-postcard","pageMetadata":{"title":"Retrieve a postcard","description":"Returns one of your postcards. A postcard from the other mode returns `404`. Requires the `postcards:read` ability.","deprecated":null,"version":null,"openapi":"/en/openapi.yaml get /api/postcards/{id}","href":"/api-reference/postcards/retrieve-a-postcard","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns one of your postcards. A postcard from the other mode returns \", _jsx(_components.code, {\n children: \"404\"\n }), \". Requires the \", _jsx(_components.code, {\n children: \"postcards:read\"\n }), \" ability.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a postcard","description":"Returns one of your postcards. A postcard from the other mode returns `404`. Requires the `postcards:read` ability.","deprecated":null,"version":null,"openapi":"/en/openapi.yaml get /api/postcards/{id}","href":"/api-reference/postcards/retrieve-a-postcard","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Postcards"],"summary":"Retrieve a postcard","description":"Returns one of your postcards. A postcard from the other mode returns `404`. Requires the `postcards:read` ability.","operationId":"getPostcard","parameters":["a82fdf4d-9e9c-41c3-abb3-411cc24ba69a"],"responses":{"200":"c583981a-4b49-4b0c-914b-559c3e01e003","401":"55966d8d-0617-4024-afab-5dc431b18c9e","403":"df250d23-b140-43ce-b5e1-54d2ac371015","404":"e44547d1-661b-416c-863e-a1e86e7f3eec"},"method":"get","type":"path","servers":["0374767e-0eb3-4424-9196-d8e91a78bd27"],"security":["4f957ae1-e817-42ef-b16d-93e50319f2c3"],"path":"/api/postcards/{id}","baseUrlOptions":["https://paperjoy.co"],"title":"Retrieve a postcard","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a82fdf4d-9e9c-41c3-abb3-411cc24ba69a":{"name":"id","in":"path","required":true,"description":"The postcard ID returned when you created it.","schema":{"type":"string","examples":["pc_MXP7a4Ni0c"],"isRequired":true,"description":"The postcard ID returned when you created it.","uniqueKey":"","typeLabel":"string"}}},"responses":{"c583981a-4b49-4b0c-914b-559c3e01e003":{"description":"The postcard.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["id","test_mode","recipient","signature","signature_id","mistake","status","submitted_at","sent_at","created_at","updated_at"],"properties":{"id":{"type":"string","examples":["pc_MXP7a4Ni0c"],"isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"test_mode":{"type":"boolean","description":"`true` for a test postcard. Test postcards are free and are never written or mailed.","isRequired":true,"uniqueKey":"data.test_mode","typeLabel":"boolean"},"recipient":{"oneOf":[{"type":"object","description":"Send `first_name`, `company_name`, or both.","properties":{"prefix":{"oneOf":[{"type":"string","maxLength":30,"examples":["Pani"],"uniqueKey":"data.recipient.oneOf.0.prefix.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":30,"examples":["Pani"],"uniqueKey":"data.recipient.oneOf.0.prefix.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recipient.oneOf.0.prefix","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"data.recipient.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"data.recipient.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recipient.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"data.recipient.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"data.recipient.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recipient.oneOf.0.last_name","typeLabel":"string | null"},"company_name":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"data.recipient.oneOf.0.company_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"data.recipient.oneOf.0.company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recipient.oneOf.0.company_name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.recipient.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.recipient.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.recipient","typeLabel":"object | null"},"signature":{"oneOf":[{"type":"string","maxLength":50,"description":"The typed signature, or `null` when the postcard uses a custom signature.","isRequired":true,"uniqueKey":"data.signature.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":50,"description":"The typed signature, or `null` when the postcard uses a custom signature.","isRequired":true,"uniqueKey":"data.signature.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.signature","typeLabel":"string | null"},"signature_id":{"oneOf":[{"type":"string","description":"The custom signature used on the postcard, or `null`.","examples":["sig_ZeXOkSQjTp"],"isRequired":true,"uniqueKey":"data.signature_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The custom signature used on the postcard, or `null`.","examples":["sig_ZeXOkSQjTp"],"isRequired":true,"uniqueKey":"data.signature_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.signature_id","typeLabel":"string | null"},"mistake":{"type":"boolean","description":"Whether one word is crossed out and rewritten to look naturally handwritten.","isRequired":true,"uniqueKey":"data.mistake","typeLabel":"boolean"},"status":{"type":"string","description":"Where the postcard is in production. Treat unknown values as \"in progress\".","enum":["draft","new","queued","rejected","pair_claimed","in_progress","pair_completed","sent"],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"submitted_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the postcard was ordered. `null` while it's a draft.","isRequired":true,"uniqueKey":"data.submitted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the postcard was ordered. `null` while it's a draft.","isRequired":true,"uniqueKey":"data.submitted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.submitted_at","typeLabel":"string\u003cdate-time> | null"},"sent_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the postcard was mailed. `null` until the status is `sent`.","isRequired":true,"uniqueKey":"data.sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the postcard was mailed. `null` until the status is `sent`.","isRequired":true,"uniqueKey":"data.sent_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.sent_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time> | null"},"address":{"oneOf":[{"type":"object","description":"The delivery address. Can be `null` only in a draft.","required":["line_1","postal_code","country","city"],"properties":{"line_1":{"type":"string","maxLength":255,"description":"Street and building number.","examples":["ul. Marszałkowska 10"],"isRequired":true,"uniqueKey":"data.address.oneOf.0.line_1","typeLabel":"string"},"postal_code":{"type":"string","pattern":"^\\d{2}-\\d{3}$","examples":["00-001"],"isRequired":true,"uniqueKey":"data.address.oneOf.0.postal_code","typeLabel":"string"},"country":{"type":"string","enum":["PL"],"isRequired":true,"uniqueKey":"data.address.oneOf.0.country","typeLabel":"enum\u003cstring>"},"city":{"type":"string","maxLength":255,"examples":["Warszawa"],"isRequired":true,"uniqueKey":"data.address.oneOf.0.city","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","maxLength":255,"description":"Apartment, floor, or other detail.","examples":["m. 4"],"uniqueKey":"data.address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Apartment, floor, or other detail.","examples":["m. 4"],"uniqueKey":"data.address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address.oneOf.0.line_2","typeLabel":"string | null"}},"uniqueKey":"data.address.oneOf.0","typeLabel":"object"},{"type":"null","description":"The delivery address. Can be `null` only in a draft.","uniqueKey":"data.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address","typeLabel":"object | null"},"content":{"oneOf":[{"type":"string","maxLength":300,"description":"The message. Can be `null` only in a draft.","uniqueKey":"data.content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":300,"description":"The message. Can be `null` only in a draft.","uniqueKey":"data.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content","typeLabel":"string | null"},"font_id":{"oneOf":[{"type":"string","description":"The handwriting. Can be `null` only in a draft.","enum":["font-1","font-2"],"uniqueKey":"data.font_id.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The handwriting. Can be `null` only in a draft.","uniqueKey":"data.font_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.font_id","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"pc_MXP7a4Ni0c","test_mode":true,"recipient":{"prefix":"Pani","first_name":"\u003cstring>","last_name":"\u003cstring>","company_name":"\u003cstring>"},"signature":"\u003cstring>","signature_id":"sig_ZeXOkSQjTp","mistake":true,"status":"draft","submitted_at":"2023-11-07T05:31:56Z","sent_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","address":{"line_1":"ul. Marszałkowska 10","postal_code":"00-001","country":"PL","city":"Warszawa","line_2":"m. 4"},"content":"\u003cstring>","font_id":"font-1"}}}},"exampleType":"generated"}},"exampleType":"generated"},"55966d8d-0617-4024-afab-5dc431b18c9e":{"description":"The API key is missing, invalid, revoked, or expired.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unauthenticated."},"examples":{"Example":{"title":"Example","value":{"message":"Unauthenticated."}}},"exampleType":"examples"}},"exampleType":"examples"},"df250d23-b140-43ce-b5e1-54d2ac371015":{"description":"The API key lacks the required ability, or the resource belongs to someone else.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"This action is unauthorized."},"examples":{"Example":{"title":"Example","value":{"message":"This action is unauthorized."}}},"exampleType":"examples"}},"exampleType":"examples"},"e44547d1-661b-416c-863e-a1e86e7f3eec":{"description":"The resource does not exist or belongs to the other mode.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Not found."},"examples":{"Example":{"title":"Example","value":{"message":"Not found."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4f957ae1-e817-42ef-b16d-93e50319f2c3":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A Paperjoy API key. Keys starting with `pj_test_` use test mode; keys starting with `pj_live_` use live mode.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0374767e-0eb3-4424-9196-d8e91a78bd27":{"url":"https://paperjoy.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A Paperjoy API key. Keys starting with `pj_test_` use test mode; keys starting with `pj_live_` use live mode.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A Paperjoy API key. Keys starting with `pj_test_` use test mode; keys starting with `pj_live_` use live mode.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"en/openapi.yaml"},"subdomain":"paperjoy","siteName":"Paperjoy","title":"Retrieve a postcard - Paperjoy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pl":{"href":"/","matchLevel":3},"en":{"href":"/api-reference/postcards/retrieve-a-postcard","matchLevel":0}}},"lastModified":"2026-11-02T13:36:14.919Z","originalFileLocation":"api-reference/postcards/retrieve-a-postcard.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns one of your postcards. A postcard from the other mode returns 404. Requires the postcards:read ability.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paperjoy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a postcard - Paperjoy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns one of your postcards. A postcard from the other mode returns 404. Requires the postcards:read ability.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paperjoy Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paperjoy.mintlify.app/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Retrieve+a+postcard\u0026amp;description=Returns+one+of+your+postcards.+A+postcard+from+the+other+mode+returns+%60404%60.+Requires+the+%60postcards%3Aread%60+ability.\u0026amp;theme=f50a3cf5b4b6d1969d867276\u0026amp;signature=0aac25a7a7cb7bcba6a31263f8ff5f3ab35faa33cf46f29cd7b01a1bd05ec575\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a postcard - Paperjoy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns one of your postcards. A postcard from the other mode returns 404. Requires the postcards:read ability.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paperjoy.mintlify.app/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Retrieve+a+postcard\u0026amp;description=Returns+one+of+your+postcards.+A+postcard+from+the+other+mode+returns+%60404%60.+Requires+the+%60postcards%3Aread%60+ability.\u0026amp;theme=f50a3cf5b4b6d1969d867276\u0026amp;signature=0aac25a7a7cb7bcba6a31263f8ff5f3ab35faa33cf46f29cd7b01a1bd05ec575\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paperjoy/h4jTuCJJKXjK5S8U/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paperjoy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/postcards/retrieve-a-postcard.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://paperjoy.co/#organization\",\"name\":\"Paperjoy\",\"legalName\":\"Paperjoy Norbert Jurga\",\"url\":\"https://paperjoy.co/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://paperjoy.co/icon-512.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paperjoy.co#website\",\"name\":\"Paperjoy\",\"url\":\"https://docs.paperjoy.co\",\"publisher\":{\"@id\":\"https://paperjoy.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard#webpage\",\"url\":\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard\",\"name\":\"Retrieve a postcard\",\"description\":\"Returns one of your postcards. A postcard from the other mode returns 404. Requires the postcards:read ability.\",\"dateModified\":\"2026-11-02T13:36:14.919Z\",\"isPartOf\":{\"@id\":\"https://docs.paperjoy.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.paperjoy.co/en/reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Endpoints\",\"item\":\"https://docs.paperjoy.co/api-reference/account/get-the-account\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a postcard\",\"item\":\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard#apireference\",\"headline\":\"Retrieve a postcard\",\"name\":\"Retrieve a postcard\",\"description\":\"Returns one of your postcards. A postcard from the other mode returns 404. Requires the postcards:read ability.\",\"url\":\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paperjoy.co/api-reference/postcards/retrieve-a-postcard#webpage\"},\"dateModified\":\"2026-11-02T13:36:14.919Z\",\"publisher\":{\"@id\":\"https://paperjoy.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paperjoy.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paperjoy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Paperjoy","nav":{"global":{"anchors":[{"anchor":"Paperjoy","icon":"house","href":"/"},{"anchor":"API","icon":"square-terminal","href":"/reference/introduction"},{"anchor":"Changelog","icon":"scroll-text","href":"/changelog"}]},"directory":"card","languages":[{"language":"pl","default":true,"navbar":{"links":[],"primary":{"type":"button","label":"Otwórz Paperjoy","href":"https://paperjoy.co"}},"pages":[{"title":"pl","href":"/"}]},{"language":"en","navbar":{"links":[],"primary":{"type":"button","label":"Open Paperjoy","href":"https://paperjoy.co"}},"groups":[{"group":"Get started","icon":"rocket","expanded":true,"pages":[{"title":"Paperjoy documentation","sidebarTitle":"Home","mode":"frame","href":"/en"},{"title":"How Paperjoy works","icon":"lightbulb","href":"/en/getting-started/introduction"},{"title":"Quickstart: your first postcard via the API","sidebarTitle":"Quickstart","icon":"rocket","href":"/en/getting-started/quickstart"},{"title":"Test mode","icon":"flask-conical","href":"/en/getting-started/test-mode"},{"title":"API keys","icon":"key-round","href":"/en/getting-started/authentication"}]},{"group":"Ways to send","icon":"send","expanded":true,"pages":[{"title":"Editor","icon":"pen-line","href":"/en/integrations/editor"},{"title":"Paperjoy Zapier integration","sidebarTitle":"Zapier","icon":"workflow","href":"/en/integrations/zapier"},{"title":"Paperjoy MCP server for Claude and AI assistants","sidebarTitle":"MCP server","icon":"bot","href":"/en/integrations/mcp"}]},{"group":"Postcards","icon":"mail","expanded":true,"pages":[{"title":"Write the card","icon":"pen-line","href":"/en/postcards/write"},{"title":"Custom signatures","icon":"signature","href":"/en/postcards/custom-signatures"},{"title":"Addresses and envelopes","icon":"map-pin","href":"/en/postcards/supported-countries"},{"title":"Preview a postcard","icon":"image","href":"/en/postcards/preview"},{"title":"Create a postcard","icon":"send","href":"/en/postcards/create"},{"title":"Draft postcards: prepare, review, and send later","sidebarTitle":"Drafts","icon":"file-pen","href":"/en/postcards/drafts"},{"title":"Track postcards","icon":"list","href":"/en/postcards/list-and-retrieve"},{"title":"Postcard statuses","icon":"route","href":"/en/postcards/statuses"}]},{"group":"Account","icon":"wallet","expanded":true,"pages":[{"title":"Credits and billing","icon":"wallet","href":"/en/account/credits-and-billing"}]},{"group":"API reference","icon":"braces","expanded":true,"pages":[{"title":"Paperjoy API overview","sidebarTitle":"API overview","icon":"braces","href":"/en/reference/introduction"},{"title":"Errors and rate limits","icon":"circle-alert","href":"/en/reference/errors-and-rate-limits"},{"group":"Endpoints","pages":[{"title":"Get the account","deprecated":null,"version":null,"openapi":"/en/openapi.yaml get /api/user","href":"/api-reference/account/get-the-account"},{"title":"Create a postcard","deprecated":null,"version":null,"openapi":"/en/openapi.yaml post /api/postcards","href":"/api-reference/postcards/create-a-postcard"},{"title":"Preview a postcard","deprecated":null,"version":null,"openapi":"/en/openapi.yaml post /api/postcards/preview","href":"/api-reference/postcards/preview-a-postcard"},{"title":"List postcards","description":"Returns your postcards in the API key's mode, newest first, one page at a time. Use `page` and `per_page` to move through the list, and follow `links.next` until it is `null`. Requires the `postcards:read` ability.","deprecated":null,"version":null,"openapi":"/en/openapi.yaml get /api/postcards","href":"/api-reference/postcards/list-postcards"},{"title":"Retrieve a postcard","deprecated":null,"version":null,"openapi":"/en/openapi.yaml get /api/postcards/{id}","href":"/api-reference/postcards/retrieve-a-postcard"},{"title":"Update a draft","description":"Changes only the draft fields you send. `null` clears a field, and `address` and `recipient` are replaced as a whole. A postcard that is no longer a draft can't be changed (`409`). Fields that aren't listed, such as `status`, return `422`. Requires the `postcards:write` ability.","deprecated":null,"version":null,"openapi":"/en/openapi.yaml patch /api/postcards/{id}","href":"/api-reference/postcards/update-a-draft"},{"title":"Delete a draft","deprecated":null,"version":null,"openapi":"/en/openapi.yaml delete /api/postcards/{id}","href":"/api-reference/postcards/delete-a-draft"},{"title":"Submit a draft","deprecated":null,"version":null,"openapi":"/en/openapi.yaml post /api/postcards/{id}/submit","href":"/api-reference/postcards/submit-a-draft"},{"title":"List signatures","deprecated":null,"version":null,"openapi":"/en/openapi.yaml get /api/signatures","href":"/api-reference/signatures/list-signatures"},{"title":"Retrieve a signature","deprecated":null,"version":null,"openapi":"/en/openapi.yaml get /api/signatures/{id}","href":"/api-reference/signatures/retrieve-a-signature"},{"title":"Delete a signature","deprecated":null,"version":null,"openapi":"/en/openapi.yaml delete /api/signatures/{id}","href":"/api-reference/signatures/delete-a-signature"}]},{"title":"Changelog","href":"/en/changelog"}]}]}]},"basePath":"","title":"Retrieve a postcard - Paperjoy","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}