Can be used for house purchase anniversaries, move-in dates, or any recurring annual milestone. Anniversary date in ISO 8601 format (YYYY-MM-DD) or null if not set. If provided as MM/DD/YYYY in requests, it will be converted to ISO 8601 format.
The property (absentee) address the absentee image template and message variables use, or null when none is set. Mail is delivered to address, not here.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"thanks.io Direct Mail Automation Toolkit","colors":{"primary":"#4c1180","light":"#8e56f3","dark":"#6822c7"},"logo":{"light":"https://mintcdn.com/thanksio/jRViseKcOKEicv0x/logo/light.svg?fit=max\u0026auto=format\u0026n=jRViseKcOKEicv0x\u0026q=85\u0026s=a63121814f9dc669a8d9dd480d2ed672","dark":"https://mintcdn.com/thanksio/jRViseKcOKEicv0x/logo/dark.svg?fit=max\u0026auto=format\u0026n=jRViseKcOKEicv0x\u0026q=85\u0026s=e0e960050738128dafc05dcb4aee7a69"},"favicon":"https://mintcdn.com/thanksio/jRViseKcOKEicv0x/favicon.svg?fit=max\u0026auto=format\u0026n=jRViseKcOKEicv0x\u0026q=85\u0026s=aecbb51507c67d60ae8911184b6d9fa0","api":{"playground":{"display":"interactive"},"examples":{"languages":["javascript","curl","python"]}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"icon":"headset","href":"https://calendly.com/thanks-io/","label":"Schedule API Consult"},{"icon":"gauge","href":"https://dashboard.thanks.io","label":"Dashboard"}],"primary":{"type":"button","label":"Create Free Account w/ $10 in Credits","href":"https://dashboard.thanks.io/register?signup_source=api_docs"}},"footer":{"socials":{"facebook":"https://www.facebook.com/groups/thanksio","github":"https://github.com/thanks-io","linkedin":"https://www.linkedin.com/company/11209125","youtube":"https://www.youtube.com/c/thanksio","x":"https://twitter.com/thanks_io_","instagram":"https://www.instagram.com/thanks.io"},"links":[{"header":"Resources","items":[{"label":"Help Docs","href":"https://help.thanks.io"},{"label":"Schedule API Consult","href":"https://calendly.com/thanks-io"},{"label":"Postman","href":"https://postman.thanks.io"}]},{"header":"Company","items":[{"label":"Website","href":"https://thanks.io"},{"label":"Contact","href":"mailto:support@thanks.io"}]}]},"integrations":{"posthog":{"apiKey":"phc_x9vVXcHH4npVKd6yxRGdCcSSLkfQ7hUYzDyhdhXrA6Uj","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"thanksio","hasAudioNarration":false,"actualSubdomain":"thanksio","customDomains":["docs.thanks.io"],"gitSource":{"type":"github","owner":"thanks-io","repo":"thanks.io-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6aeddc7a1c1ad53e5000ed82","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":73},{"language":"default","tag":"API Endpoints","count":61},{"language":"default","tag":"Design Gallery","count":46},{"language":"default","tag":"Inspirations","count":38},{"language":"default","tag":"Postcards","count":35},{"language":"default","tag":"Native Integrations","count":17},{"language":"default","tag":"Get Started","count":13},{"language":"default","tag":"Account","count":12},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"General Integrations","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/recipients/get-details","slug":"/api-reference/endpoint/recipients/get-details","pageMetadata":{"openapi":"get /recipients/{recipientId}","title":"Recipient Details","description":"Get a recipient by ID.","href":"/api-reference/endpoint/recipients/get-details"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get a recipient by ID.\"\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":{"openapi":"get /recipients/{recipientId}","title":"Recipient Details","description":"Get a recipient by ID.","href":"/api-reference/endpoint/recipients/get-details"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Recipients"],"operationId":"getRecipientsDetails","summary":"Get Recipient","description":"Get a recipient by ID.","responses":{"200":"ce4b0095-bba2-4239-9c28-e7f352433c95","403":"d93c0caa-192a-40fd-af67-28e6026f0558","404":"9b1f2c51-1875-4c79-a8b5-43dc09fad414"},"method":"get","type":"path","servers":["707b46ab-cdbf-4d64-b507-a18ba0668278"],"security":["a8bec680-428c-4b45-8ecd-d3fba3e2f21a"],"path":"/recipients/{recipientId}","baseUrlOptions":["https://api.thanks.io/api/v2"],"title":"Get Recipient","codeSamples":[],"requestExampleLanguages":["javascript","bash","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"802adf65-7b4a-4a8b-9294-1ebb91b2559c":{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"schema":{"type":"integer","example":296446,"isRequired":true,"description":"Recipient ID","uniqueKey":"","typeLabel":"integer"}}},"responses":{"ce4b0095-bba2-4239-9c28-e7f352433c95":{"description":"Successful Response","headers":{"Content-Type":{"schema":{"type":"string","example":"application/json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","example":18113288,"readOnly":true,"uniqueKey":"id","typeLabel":"integer"},"mailing_list_id":{"type":"integer","example":1,"uniqueKey":"mailing_list_id","typeLabel":"integer"},"name":{"type":"string","example":"Tobias Example","uniqueKey":"name","typeLabel":"string"},"company":{"type":"string","example":"thanks.io","uniqueKey":"company","typeLabel":"string"},"address":{"type":"string","example":"123 Main Street","uniqueKey":"address","typeLabel":"string"},"address2":{"type":"string","example":"Apartment 1","uniqueKey":"address2","typeLabel":"string"},"city":{"type":"string","example":"Any Town","uniqueKey":"city","typeLabel":"string"},"province":{"type":"string","description":"State or Province","example":"KS","uniqueKey":"province","typeLabel":"string"},"postal_code":{"type":"string","example":"12345","uniqueKey":"postal_code","typeLabel":"string"},"country":{"type":"string","example":"US","uniqueKey":"country","typeLabel":"string"},"dob":{"type":"string","description":"Date of Birth in ISO 8601 format (YYYY-MM-DD) or null if not set. If provided as MM/DD/YYYY in requests, it will be converted to ISO 8601 format.","example":"1981-04-23","uniqueKey":"dob","typeLabel":"string"},"anniversary":{"type":"string","description":"Can be used for house purchase anniversaries, move-in dates, or any recurring annual milestone. Anniversary date in ISO 8601 format (YYYY-MM-DD) or null if not set. If provided as MM/DD/YYYY in requests, it will be converted to ISO 8601 format.","example":"2025-07-21","uniqueKey":"anniversary","typeLabel":"string"},"email":{"type":"string","example":"tobias@example.com","uniqueKey":"email","typeLabel":"string"},"phone":{"type":"string","example":"+1 (555) 123-4567","uniqueKey":"phone","typeLabel":"string"},"custom1":{"type":"string","description":"Custom field for additional information about the recipient","example":"Unique Info","uniqueKey":"custom1","typeLabel":"string"},"custom2":{"type":"string","description":"Custom field for additional information about the recipient","example":"For example a product code or customer ID","uniqueKey":"custom2","typeLabel":"string"},"custom3":{"type":"string","description":"Custom field for additional information about the recipient","example":"Any Extra Info","uniqueKey":"custom3","typeLabel":"string"},"custom4":{"type":"string","description":"Custom field for additional information about the recipient","example":"Any Extra Info","uniqueKey":"custom4","typeLabel":"string"},"custom5":{"type":"string","description":"Custom field for additional information about the recipient","example":"Any Extra Info","uniqueKey":"custom5","typeLabel":"string"},"custom6":{"type":"string","description":"Custom field for additional information about the recipient","example":"Any Extra Info","uniqueKey":"custom6","typeLabel":"string"},"custom7":{"type":"string","description":"Custom field for additional information about the recipient","example":"Any Extra Info","uniqueKey":"custom7","typeLabel":"string"},"custom8":{"type":"string","description":"Custom field for additional information about the recipient","example":"Any Extra Info","uniqueKey":"custom8","typeLabel":"string"},"custom9":{"type":"string","description":"Custom field for additional information about the recipient","example":"Any Extra Info","uniqueKey":"custom9","typeLabel":"string"},"custom10":{"type":"string","description":"Custom field for additional information about the recipient","example":"Any Extra Info","uniqueKey":"custom10","typeLabel":"string"},"absentee_address":{"oneOf":[{"type":"string","description":"The property (absentee) address the absentee image template and message variables use, or null when none is set. Mail is delivered to `address`, not here.","example":"742 Evergreen Terrace, Springfield, IL 62704","uniqueKey":"absentee_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"The property (absentee) address the absentee image template and message variables use, or null when none is set. Mail is delivered to `address`, not here.","example":"742 Evergreen Terrace, Springfield, IL 62704","uniqueKey":"absentee_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"absentee_address","typeLabel":"string | null"},"mailing-list":{"type":"object","description":"The mailing list this recipient belongs to","properties":{"id":{"type":"integer","example":1,"uniqueKey":"mailing-list.id","typeLabel":"integer"},"user_id":{"type":"integer","example":2,"uniqueKey":"mailing-list.user_id","typeLabel":"integer"},"sub_account_id":{"oneOf":[{"type":"integer","uniqueKey":"mailing-list.sub_account_id.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"mailing-list.sub_account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailing-list.sub_account_id","typeLabel":"integer | null"},"type":{"type":"string","example":"manual","enum":["csv","manual","map","friends","retarget","leads","zapier","radius","highlevel","qrscans"],"uniqueKey":"mailing-list.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","example":"Test","uniqueKey":"mailing-list.description","typeLabel":"string"},"qrcode_url":{"oneOf":[{"type":"string","uniqueKey":"mailing-list.qrcode_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"mailing-list.qrcode_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailing-list.qrcode_url","typeLabel":"string | null"},"total_recipients":{"type":"integer","example":1,"uniqueKey":"mailing-list.total_recipients","typeLabel":"integer"},"processed":{"type":"boolean","example":true,"uniqueKey":"mailing-list.processed","typeLabel":"boolean"},"is_suppression_list":{"type":"boolean","example":false,"uniqueKey":"mailing-list.is_suppression_list","typeLabel":"boolean"},"total_scans":{"type":"integer","example":0,"uniqueKey":"mailing-list.total_scans","typeLabel":"integer"},"unique_scans":{"type":"integer","example":0,"uniqueKey":"mailing-list.unique_scans","typeLabel":"integer"},"last_scan":{"oneOf":[{"type":"string","uniqueKey":"mailing-list.last_scan.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"mailing-list.last_scan.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailing-list.last_scan","typeLabel":"string | null"},"total_sends":{"type":"integer","example":0,"uniqueKey":"mailing-list.total_sends","typeLabel":"integer"},"last_send":{"oneOf":[{"type":"string","uniqueKey":"mailing-list.last_send.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"mailing-list.last_send.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailing-list.last_send","typeLabel":"string | null"},"api_key":{"type":"string","description":"API key that can be used to add recipients to this mailing list with thanks.io Webhooks","example":"abcd1234efgh5678ijkl9012mnop3456","uniqueKey":"mailing-list.api_key","typeLabel":"string"},"created_at":{"type":"string","example":"2018-07-15T06:06:57.000000Z","format":"date-time","uniqueKey":"mailing-list.created_at","typeLabel":"string\u003cdate-time>"},"created_at_diff":{"type":"string","example":"6 years ago","description":"Human-friendly relative time since creation","uniqueKey":"mailing-list.created_at_diff","typeLabel":"string"},"updated_at":{"type":"string","example":"2025-06-27T14:57:11.000000Z","format":"date-time","uniqueKey":"mailing-list.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"mailing-list","typeLabel":"object"},"created_at":{"readOnly":true,"type":"string","example":"2025-06-27T14:57:11.000000Z","uniqueKey":"created_at","typeLabel":"string"},"updated_at":{"readOnly":true,"type":"string","example":"2025-06-27T14:57:11.000000Z","uniqueKey":"updated_at","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"recipient":{"title":"recipient","value":{"id":18113288,"mailing_list_id":1,"name":"Tobias Example","company":"thanks.io","address":"12345 Main Street","address2":"Apartment 1","city":"Any Town","province":"NY","postal_code":"12345","country":"US","dob":"1981-04-23","anniversary":"2025-07-21","email":"tobias@example.com","phone":"845-988-6485","custom1":"Unique Info","custom2":"For example a product code or customer ID","custom3":"","custom4":"","created_at":"2025-06-27T14:57:11.000000Z","updated_at":"2025-06-27T14:57:11.000000Z","mailing_list":{"id":1,"user_id":2,"sub_account_id":null,"type":"manual","description":"Sphere Contacts Mailing List","qrcode_url":null,"total_recipients":1,"processed":true,"is_suppression_list":false,"total_scans":1,"unique_scans":1,"last_scan":"2025-07-13T13:57:11.000000Z","total_sends":2,"last_send":"2025-07-06T13:57:11.000000Z","created_at":"6 years ago","updated_at":"2025-06-27T14:57:11.000000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d93c0caa-192a-40fd-af67-28e6026f0558":{"description":"Access token is missing or invalid","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unauthorized","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"9b1f2c51-1875-4c79-a8b5-43dc09fad414":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Not Found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a8bec680-428c-4b45-8ecd-d3fba3e2f21a":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token authentication using your thanks.io API key","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"707b46ab-cdbf-4d64-b507-a18ba0668278":{"url":"https://api.thanks.io/api/v2","description":"The main API server for thanks.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token authentication using your thanks.io API key","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication using your thanks.io API key","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"thanksio","siteName":"thanks.io Direct Mail Automation Toolkit","title":"Recipient Details - thanks.io Direct Mail Automation Toolkit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-01T02:55:38.453Z","originalFileLocation":"api-reference/endpoint/recipients/get-details.mdx"},"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=\"Get a recipient by ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"thanks.io Direct Mail Automation Toolkit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/thanksio/4A9jZiRamFPkvvwd/_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/thanksio/4A9jZiRamFPkvvwd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/thanksio/4A9jZiRamFPkvvwd/_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/thanksio/4A9jZiRamFPkvvwd/_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/thanksio/4A9jZiRamFPkvvwd/_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/thanksio/4A9jZiRamFPkvvwd/_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/thanksio/4A9jZiRamFPkvvwd/_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/thanksio/4A9jZiRamFPkvvwd/_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/thanksio/4A9jZiRamFPkvvwd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Recipient Details - thanks.io Direct Mail Automation Toolkit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a recipient by ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"thanks.io Direct Mail Automation Toolkit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://thanksio.mintlify.site/_mintlify/api/og/v2?division=Recipients\u0026amp;title=Recipient+Details\u0026amp;description=Get+a+recipient+by+ID.\u0026amp;theme=1264b6494f3fd6a53e585726\u0026amp;signature=f82ca006c729be3c478ddf762a991566ae94747d365e5b29d534d60c2d90921e\">\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=\"Recipient Details - thanks.io Direct Mail Automation Toolkit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a recipient by ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://thanksio.mintlify.site/_mintlify/api/og/v2?division=Recipients\u0026amp;title=Recipient+Details\u0026amp;description=Get+a+recipient+by+ID.\u0026amp;theme=1264b6494f3fd6a53e585726\u0026amp;signature=f82ca006c729be3c478ddf762a991566ae94747d365e5b29d534d60c2d90921e\">\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/thanksio/4A9jZiRamFPkvvwd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"thanks.io Direct Mail Automation Toolkit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4c1180\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/recipients/get-details.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.thanks.io/#organization\",\"name\":\"thanks.io Direct Mail Automation Toolkit\",\"url\":\"https://docs.thanks.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/thanksio/jRViseKcOKEicv0x/logo/light.svg?fit=max\u0026auto=format\u0026n=jRViseKcOKEicv0x\u0026q=85\u0026s=a63121814f9dc669a8d9dd480d2ed672\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.thanks.io#website\",\"name\":\"thanks.io Direct Mail Automation Toolkit\",\"url\":\"https://docs.thanks.io\",\"publisher\":{\"@id\":\"https://docs.thanks.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details#webpage\",\"url\":\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details\",\"name\":\"Recipient Details\",\"description\":\"Get a recipient by ID.\",\"dateModified\":\"2026-05-01T02:55:38.453Z\",\"isPartOf\":{\"@id\":\"https://docs.thanks.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Endpoints\",\"item\":\"https://docs.thanks.io/api-reference/recipients-usage\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Recipients\",\"item\":\"https://docs.thanks.io/api-reference/recipients-usage\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Recipient Details\",\"item\":\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details#apireference\",\"headline\":\"Recipient Details\",\"name\":\"Recipient Details\",\"description\":\"Get a recipient by ID.\",\"url\":\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details\",\"mainEntityOfPage\":{\"@id\":\"https://docs.thanks.io/api-reference/endpoint/recipients/get-details#webpage\"},\"dateModified\":\"2026-05-01T02:55:38.453Z\",\"publisher\":{\"@id\":\"https://docs.thanks.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.thanks.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"thanks.io Direct Mail Automation Toolkit\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"thanks.io Direct Mail Automation Toolkit\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/recipients/get-details.md","siteName":"thanks.io Direct Mail Automation Toolkit","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Design Gallery","pages":[{"title":"Design Gallery","href":"/design-gallery/introduction"}]},{"tab":"API Reference","groups":[{"group":"Get Started","icon":"play","pages":[{"title":"REST API Overview","href":"/api-reference/introduction"},{"title":"API Testing Mode","mode":"wide","href":"/api-reference/api-mode"},{"title":"API Log","href":"/api-reference/audit-log"},{"title":"Rate Limits","mode":"wide","href":"/api-reference/rate-limits"},{"title":"OpenAPI Specification","href":"/api-reference/openapi-link"}]},{"group":"Authentication","icon":"lock","pages":[{"title":"Choosing an Authentication Method","href":"/authentication/choosing-auth-method"},{"title":"Bearer Token","href":"/authentication/bearer-token"},{"title":"OAuth","href":"/authentication/oauth"}]},{"group":"API Endpoints","icon":"code","pages":[{"group":"Recipients","icon":"user","pages":[{"title":"Usage","href":"/api-reference/recipients-usage"},{"openapi":"post /recipients","title":"Create Recipient","description":"Add a recipient. If you do not provide a valid mailing address but do provide a valid email address, thanks.io can attempt to look up a street address for an additional fee.","href":"/api-reference/endpoint/recipients/create-recipient"},{"openapi":"get /recipients/{recipientId}","title":"Recipient Details","href":"/api-reference/endpoint/recipients/get-details"},{"openapi":"put /recipients/{recipientId}","title":"Update Recipient","description":"Update details of a specific recipient by ID. Leave out `absentee_address` to keep the current absentee address. Sending it replaces the stored absentee address as a whole, so send it together with any of `absentee_city`, `absentee_province` and `absentee_postal_code`: those on their own, for example only a new ZIP, are refused with a 400 and nothing is updated. Send `absentee_address` as an empty string or null to remove the absentee address; if the same request also sets `custom1` to `absentee` with an address in `custom2`, that address is copied in instead.","href":"/api-reference/endpoint/recipients/update-recipient"},{"openapi":"delete /recipients/{recipientId}","title":"Delete Recipient","href":"/api-reference/endpoint/recipients/delete-recipient"},{"openapi":"post /recipients-utils/create-multiple","title":"Create Multiple Recipients","href":"/api-reference/endpoint/recipients/create-multiple-recipients"},{"openapi":"post /recipients-utils/delete-by-address","title":"Delete Recipient By Address","href":"/api-reference/endpoint/recipients/delete-recipient-by-address"}]},{"group":"Mailing Lists","icon":"list","pages":[{"title":"Usage","href":"/api-reference/mailing-lists-usage"},{"openapi":"get /mailing-lists/","title":"List All","href":"/api-reference/endpoint/mailing-lists/list-all"},{"openapi":"post /mailing-lists/","title":"Create Mailing List","href":"/api-reference/endpoint/mailing-lists/create-mailing-list"},{"openapi":"get /mailing-lists/{mailingListId}","title":"Get Details","href":"/api-reference/endpoint/mailing-lists/get-details"},{"openapi":"delete /mailing-lists/{mailingListId}","title":"Delete Mailing List","href":"/api-reference/endpoint/mailing-lists/delete-mailing-list"},{"openapi":"get /mailing-lists-utils/recipients/{mailingListId}","title":"List Recipients","href":"/api-reference/endpoint/mailing-lists/list-recipients"},{"openapi":"post /mailing-lists-utils/count-radius-search","title":"Radius Search Count","href":"/api-reference/endpoint/mailing-lists/radius-search-count"},{"openapi":"post /mailing-lists-utils/buy-radius-search","title":"Radius Search","href":"/api-reference/endpoint/mailing-lists/radius-search"}]},{"group":"Direct Send Orders","icon":"envelope","pages":[{"title":"Usage","href":"/api-reference/send-mailer-usage"},{"openapi":"post /send/postcard","title":"Send Postcard","href":"/api-reference/endpoint/send-mailer/send-postcard"},{"openapi":"post /send/windowedletter","title":"Send Windowed Letter","href":"/api-reference/endpoint/send-mailer/send-windowed-letter"},{"openapi":"post /send/windowlessletter","title":"Send Windowless Letter","href":"/api-reference/endpoint/send-mailer/send-windowless-letter"},{"openapi":"post /send/notecard","title":"Send Notecard","href":"/api-reference/endpoint/send-mailer/send-notecard"},{"openapi":"post /send/giftcard","title":"Send Giftcard","href":"/api-reference/endpoint/send-mailer/send-giftcard"},{"openapi":"post /send/magnacard","title":"Send Magnacard","href":"/api-reference/endpoint/send-mailer/send-magnacard"}]},{"group":"Order Estimates","icon":"calculator","pages":[{"openapi":"post /estimate/postcard","title":"Estimate Postcard","href":"/api-reference/endpoint/estimate/estimate-postcard"},{"openapi":"post /estimate/windowedletter","title":"Estimate Windowed Letter","href":"/api-reference/endpoint/estimate/estimate-windowed-letter"},{"openapi":"post /estimate/windowlessletter","title":"Estimate Windowless Letter","href":"/api-reference/endpoint/estimate/estimate-windowless-letter"},{"openapi":"post /estimate/notecard","title":"Estimate Notecard","href":"/api-reference/endpoint/estimate/estimate-notecard"},{"openapi":"post /estimate/giftcard","title":"Estimate Giftcard","href":"/api-reference/endpoint/estimate/estimate-giftcard"},{"openapi":"post /estimate/magnacard","title":"Estimate Magnacard","href":"/api-reference/endpoint/estimate/estimate-magnacard"}]},{"group":"Creatives Library","icon":"palette","pages":[{"title":"Usage","href":"/api-reference/creatives-library-usage"},{"openapi":"get /creatives/","title":"List Creatives","href":"/api-reference/endpoint/creatives-library/list-all-creatives"},{"openapi":"get /creatives/{creativeId}","title":"Get Creative","href":"/api-reference/endpoint/creatives-library/get-creative"}]},{"group":"Message Templates","icon":"message","pages":[{"title":"Usage","href":"/api-reference/message-templates-usage"},{"openapi":"get /message-templates/","title":"List Message Templates","href":"/api-reference/endpoint/message-templates/list-all-message-templates"},{"openapi":"post /message-templates/","title":"Create Message Template","href":"/api-reference/endpoint/message-templates/create-message-template"},{"openapi":"get /message-templates/{messageTemplateId}","title":"Get Message Template","href":"/api-reference/endpoint/message-templates/get-message-template"},{"openapi":"patch /message-templates/{messageTemplateId}","title":"Update Message Template","href":"/api-reference/endpoint/message-templates/update-message-template"},{"openapi":"delete /message-templates/{messageTemplateId}","title":"Delete Message Template","href":"/api-reference/endpoint/message-templates/delete-message-template"}]},{"group":"Account","icon":"gear","pages":[{"openapi":"post /sub-accounts/","title":"Create Sub-Account","href":"/api-reference/endpoint/sub-accounts/create-sub-account"},{"openapi":"get /sub-accounts/{subAccountId}","title":"Show Sub-Account","href":"/api-reference/endpoint/sub-accounts/get-details"},{"openapi":"put /sub-accounts/{subAccountId}","title":"Update Sub-Account","href":"/api-reference/endpoint/sub-accounts/update-sub-account"},{"openapi":"delete /sub-accounts/{subAccountId}","title":"Delete Sub-Account","href":"/api-reference/endpoint/sub-accounts/delete-sub-account"},{"openapi":"get /sub-accounts/","title":"List Sub-Accounts","href":"/api-reference/endpoint/sub-accounts/list-all"},{"openapi":"get /image-templates/","title":"List Image Templates","href":"/api-reference/endpoint/image-templates/list-all-image-templates"},{"openapi":"get /orders/list","title":"List Orders","href":"/api-reference/endpoint/orders/list-orders"},{"openapi":"get /orders/{orderId}/track","title":"Track Order","href":"/api-reference/endpoint/orders/track-order"},{"openapi":"get /orders/{orderId}/items","title":"List Order Items","href":"/api-reference/endpoint/orders/list-order-items"},{"openapi":"put /orders/{orderId}/cancel","title":"Cancel Order","href":"/api-reference/endpoint/orders/cancel-order"},{"openapi":"post /orders/{orderId}/replay","title":"Replay Order","href":"/api-reference/endpoint/orders/replay-order"},{"openapi":"put /order-items/{orderItemId}/invalidate-giftcard","title":"Invalidate Gift Card","href":"/api-reference/endpoint/orders/invalidate-giftcard"}]},{"group":"Webhooks","icon":"list","pages":[{"openapi":"get /webhooks","title":"List Webhooks","href":"/api-reference/endpoint/webhooks/list-all"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/endpoint/webhooks/create-webhook"},{"openapi":"put /webhooks/{webhookId}","title":"Update Webhook","href":"/api-reference/endpoint/webhooks/update-webhook"},{"openapi":"delete /webhooks/{webhookId}","title":"Delete Webhook","href":"/api-reference/endpoint/webhooks/delete-webhook"}]},{"group":"Webhook Events","icon":"sparkles","pages":[{"openapi":"api-reference/openapi.json webhook orderItemStatusUpdate","title":"Order Item Status Change","href":"/api-reference/endpoint/webhook-events/order-item-status-change"},{"openapi":"api-reference/openapi.json webhook orderStatusUpdate","title":"Order Status Change","href":"/api-reference/endpoint/webhook-events/order-status-change"},{"openapi":"api-reference/openapi.json webhook orderItemDelivered","title":"Order Item Delivered","href":"/api-reference/endpoint/webhook-events/order-item-delivered"},{"openapi":"api-reference/openapi.json webhook qrCodeScanUpdate","title":"QR Code Scans","href":"/api-reference/endpoint/webhook-events/qr-code-scans"},{"openapi":"api-reference/openapi.json webhook scanBoardStatusUpdate","title":"Lead Board Stage Change","href":"/api-reference/endpoint/webhook-events/scan-board-stage-change"}]},{"group":"Utilities","icon":"wrench","pages":[{"openapi":"get /handwriting-styles","title":"List Handwriting Styles","href":"/api-reference/endpoint/handwriting-styles/list-styles"},{"openapi":"get /giftcard-brands-list","title":"List Gift Card Brands Flat","href":"/api-reference/endpoint/giftcards/list-brands-flat"},{"openapi":"get /giftcard-brands","title":"List Gift Card Brands","href":"/api-reference/endpoint/giftcards/list-brands"}]}]},{"group":"Examples","icon":"lightbulb","pages":[{"title":"Add Recipient to Campaign","icon":"address-card","tag":"Popular","href":"/workflows/campaign"},{"title":"PDF Letter Order","icon":"file-pdf","href":"/workflows/letter-pdf-order"},{"title":"Postcard Order","icon":"cards","href":"/workflows/postcard-order"},{"title":"Giftcard Order","icon":"gift","href":"/workflows/giftcard-order"}]}]},{"tab":"Native Integrations","pages":[{"title":"Native Integrations","href":"/native-integrations/introduction"}]},{"tab":"Webhooks ","pages":[{"title":"Webhooks ","href":"/webhooks/introduction"}]}]},"basePath":"","title":"Recipient Details - thanks.io Direct Mail Automation Toolkit","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}