[{"data":1,"prerenderedAt":573},["ShallowReactive",2],{"navigation_docs":3,"-recipients-list-recipients":132,"-recipients-list-recipients-surround":568},[4,26,32,53,90,103],{"title":5,"path":6,"stem":7,"children":8,"page":25},"Getting Started","\u002Fgetting-started","1.getting-started",[9,13,17,21],{"title":10,"path":11,"stem":12},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":14,"path":15,"stem":16},"Authentication","\u002Fgetting-started\u002Fauthentication","1.getting-started\u002F2.authentication",{"title":18,"path":19,"stem":20},"Campaign setup","\u002Fgetting-started\u002Fcampaigns","1.getting-started\u002F3.campaigns",{"title":22,"path":23,"stem":24},"AI agent skills","\u002Fgetting-started\u002Fai-agent-skills","1.getting-started\u002F4.ai-agent-skills",false,{"title":27,"path":28,"stem":29,"children":30},"Templates","\u002Ftemplates","2.templates\u002Findex",[31],{"title":27,"path":28,"stem":29},{"title":33,"path":34,"stem":35,"children":36,"page":25},"Campaigns","\u002Fcampaigns","3.campaigns",[37,41,45,49],{"title":38,"path":39,"stem":40},"Create campaign","\u002Fcampaigns\u002Fcreate-campaign","3.campaigns\u002F1.create-campaign",{"title":42,"path":43,"stem":44},"Fetch campaign","\u002Fcampaigns\u002Ffetch-campaign","3.campaigns\u002F2.fetch-campaign",{"title":46,"path":47,"stem":48},"List campaigns","\u002Fcampaigns\u002Flist-campaigns","3.campaigns\u002F3.list-campaigns",{"title":50,"path":51,"stem":52},"Activate campaign","\u002Fcampaigns\u002Factivate-campaign","3.campaigns\u002F4.activate-campaign",{"title":54,"path":55,"stem":56,"children":57,"page":25},"Recipients","\u002Frecipients","4.recipients",[58,62,66,70,74,78,82,86],{"title":59,"path":60,"stem":61},"Create recipients","\u002Frecipients\u002Fcreate-recipients","4.recipients\u002F1.create-recipients",{"title":63,"path":64,"stem":65},"Fetch recipient","\u002Frecipients\u002Ffetch-recipient","4.recipients\u002F2.fetch-recipient",{"title":67,"path":68,"stem":69},"Fetch recipient preview","\u002Frecipients\u002Ffetch-recipient-preview","4.recipients\u002F3.fetch-recipient-preview",{"title":71,"path":72,"stem":73},"Create HTML recipient","\u002Frecipients\u002Fcreate-html-recipient","4.recipients\u002F4.create-html-recipient",{"title":75,"path":76,"stem":77},"Checkout recipients","\u002Frecipients\u002Fcheckout-recipients","4.recipients\u002F5.checkout-recipients",{"title":79,"path":80,"stem":81},"PNG API","\u002Frecipients\u002Fpng-api","4.recipients\u002F6.png-api",{"title":83,"path":84,"stem":85},"List recipients","\u002Frecipients\u002Flist-recipients","4.recipients\u002F7.list-recipients",{"title":87,"path":88,"stem":89},"Create bulk HTML recipients","\u002Frecipients\u002Fcreate-bulk-html-recipients","4.recipients\u002F8.create-bulk-html-recipients",{"title":91,"path":92,"stem":93,"children":94,"page":25},"Partner Workflows","\u002Fpartner-workflows","5.partner-workflows",[95,99],{"title":96,"path":97,"stem":98},"Create partner team","\u002Fpartner-workflows\u002Fcreate-partner-team","5.partner-workflows\u002F1.create-partner-team",{"title":100,"path":101,"stem":102},"Account status","\u002Fpartner-workflows\u002Faccount-status","5.partner-workflows\u002F2.account-status",{"title":104,"path":105,"stem":106,"children":107,"page":25},"Webhooks","\u002Fwebhooks","6.webhooks",[108,112,116,120,124,128],{"title":109,"path":110,"stem":111},"Overview","\u002Fwebhooks\u002Foverview","6.webhooks\u002F0.overview",{"title":113,"path":114,"stem":115},"Manage subscriptions","\u002Fwebhooks\u002Fmanage-subscriptions","6.webhooks\u002F1.manage-subscriptions",{"title":117,"path":118,"stem":119},"Recipient events","\u002Fwebhooks\u002Frecipient-events","6.webhooks\u002F2.recipient-events",{"title":121,"path":122,"stem":123},"QR scan events","\u002Fwebhooks\u002Fqr-code-scans","6.webhooks\u002F3.qr-code-scans",{"title":125,"path":126,"stem":127},"Receive deliveries","\u002Fwebhooks\u002Freceive-deliveries","6.webhooks\u002F4.receive-deliveries",{"title":129,"path":130,"stem":131},"Test and resend","\u002Fwebhooks\u002Ftest-and-resend","6.webhooks\u002F5.test-and-resend",{"id":133,"title":83,"body":134,"description":561,"extension":562,"links":563,"meta":564,"navigation":565,"path":84,"seo":566,"stem":85,"__hash__":567},"docs\u002F4.recipients\u002F7.list-recipients.md",{"type":135,"value":136,"toc":554},"minimark",[137,161,165,170,291,294,306,310,425,435,439,462,469,473,492,496,550],[138,139,144],"pre",{"className":140,"code":141,"language":142,"meta":143,"style":143},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GET https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\nX-API-Key: YOUR_API_KEY\n","http","",[145,146,147,155],"code",{"__ignoreMap":143},[148,149,152],"span",{"class":150,"line":151},"line",1,[148,153,154],{},"GET https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\n",[148,156,158],{"class":150,"line":157},2,[148,159,160],{},"X-API-Key: YOUR_API_KEY\n",[162,163,164],"p",{},"Returns a JSON array of recipients accessible to your API key, including their campaign summaries and generated document records. Shipped and delivered recipients are included unless you filter by status. Deleted recipients are excluded by default.",[166,167,169],"h2",{"id":168},"query-parameters","Query parameters",[171,172,173,189],"table",{},[174,175,176],"thead",{},[177,178,179,183,186],"tr",{},[180,181,182],"th",{},"Parameter",[180,184,185],{},"Type",[180,187,188],{},"Description",[190,191,192,206,222,261,278],"tbody",{},[177,193,194,200,203],{},[195,196,197],"td",{},[145,198,199],{},"campaignId",[195,201,202],{},"string",[195,204,205],{},"Restrict results to one campaign.",[177,207,208,213,215],{},[195,209,210],{},[145,211,212],{},"externalId",[195,214,202],{},[195,216,217,218,221],{},"Exact, case-sensitive match against the stored ",[145,219,220],{},"variables.externalId",". Leading and trailing whitespace is removed; an empty value is rejected. Multiple recipients may share an external ID.",[177,223,224,229,231],{},[195,225,226],{},[145,227,228],{},"status",[195,230,202],{},[195,232,233,234,237,238,237,241,237,244,237,247,237,250,237,253,256,257,260],{},"Recipient lifecycle status: ",[145,235,236],{},"pending",", ",[145,239,240],{},"invalid",[145,242,243],{},"ready",[145,245,246],{},"printing",[145,248,249],{},"shipped",[145,251,252],{},"delivered",[145,254,255],{},"deleted",", or ",[145,258,259],{},"ignored",".",[177,262,263,268,271],{},[195,264,265],{},[145,266,267],{},"page",[195,269,270],{},"positive integer",[195,272,273,274,277],{},"Page number, starting at 1. Defaults to 1 when only ",[145,275,276],{},"pageSize"," is supplied.",[177,279,280,284,286],{},[195,281,282],{},[145,283,276],{},[195,285,270],{},[195,287,288,289,277],{},"Rows per page. Defaults to 50 when only ",[145,290,267],{},[162,292,293],{},"Filters are combined. Results are ordered newest first, with recipient ID as a tie-breaker. The response is an array, without a total count or pagination envelope.",[162,295,296,297,299,300,302,303,305],{},"Always supply ",[145,298,267],{}," and ",[145,301,276],{}," when listing large collections. Omitting both leaves the result subject to the database response limit; it does not guarantee every recipient. Continue requesting pages until an empty array is returned. If the service truncates a page below the requested size, reduce ",[145,304,276],{}," before continuing. As with other page-number APIs, concurrent additions or removals can move rows between pages.",[166,307,309],{"id":308},"example-request","Example request",[138,311,315],{"className":312,"code":313,"language":314,"meta":143,"style":143},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --get 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients' \\\n  --header 'X-API-Key: YOUR_API_KEY' \\\n  --data-urlencode 'externalId=order_12345' \\\n  --data-urlencode 'campaignId=CAMPAIGN_ID' \\\n  --data-urlencode 'status=pending' \\\n  --data-urlencode 'page=1' \\\n  --data-urlencode 'pageSize=200'\n","bash",[145,316,317,341,355,370,384,398,412],{"__ignoreMap":143},[148,318,319,323,327,331,334,337],{"class":150,"line":151},[148,320,322],{"class":321},"sBMFI","curl",[148,324,326],{"class":325},"sfazB"," --get",[148,328,330],{"class":329},"sMK4o"," '",[148,332,333],{"class":325},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients",[148,335,336],{"class":329},"'",[148,338,340],{"class":339},"sTEyZ"," \\\n",[148,342,343,346,348,351,353],{"class":150,"line":157},[148,344,345],{"class":325},"  --header",[148,347,330],{"class":329},[148,349,350],{"class":325},"X-API-Key: YOUR_API_KEY",[148,352,336],{"class":329},[148,354,340],{"class":339},[148,356,358,361,363,366,368],{"class":150,"line":357},3,[148,359,360],{"class":325},"  --data-urlencode",[148,362,330],{"class":329},[148,364,365],{"class":325},"externalId=order_12345",[148,367,336],{"class":329},[148,369,340],{"class":339},[148,371,373,375,377,380,382],{"class":150,"line":372},4,[148,374,360],{"class":325},[148,376,330],{"class":329},[148,378,379],{"class":325},"campaignId=CAMPAIGN_ID",[148,381,336],{"class":329},[148,383,340],{"class":339},[148,385,387,389,391,394,396],{"class":150,"line":386},5,[148,388,360],{"class":325},[148,390,330],{"class":329},[148,392,393],{"class":325},"status=pending",[148,395,336],{"class":329},[148,397,340],{"class":339},[148,399,401,403,405,408,410],{"class":150,"line":400},6,[148,402,360],{"class":325},[148,404,330],{"class":329},[148,406,407],{"class":325},"page=1",[148,409,336],{"class":329},[148,411,340],{"class":339},[148,413,415,417,419,422],{"class":150,"line":414},7,[148,416,360],{"class":325},[148,418,330],{"class":329},[148,420,421],{"class":325},"pageSize=200",[148,423,424],{"class":329},"'\n",[162,426,427,428,431,432,434],{},"No matching recipients returns ",[145,429,430],{},"[]",". The external ID is stored under ",[145,433,220],{}," in each recipient; it is not a unique Scribeless recipient ID.",[166,436,438],{"id":437},"list-the-active-cart","List the active cart",[162,440,441,442,445,446,449,450,453,454,457,458,461],{},"Fetch ",[145,443,444],{},"GET \u002Fapi\u002Fcarts\u002Factive"," with the same API key. Each item in ",[145,447,448],{},"campaigns"," contains a nested ",[145,451,452],{},"campaign"," object. For each ",[145,455,456],{},"campaigns[].campaign.id",", list recipients with ",[145,459,460],{},"campaignId=\u003Cid>&status=pending&page=1&pageSize=200",", then continue through the pages.",[162,463,464,465,468],{},"This restricts the list to pending recipients in the cart's campaigns. There is no direct cart filter on the recipients endpoint. Invalid recipients require a separate ",[145,466,467],{},"status=invalid"," request if you want to inspect validation failures.",[166,470,472],{"id":471},"recipient-status-and-rendering","Recipient status and rendering",[162,474,475,477,478,480,481,484,485,488,489,491],{},[145,476,228],{}," describes the recipient lifecycle, not rendering progress. A one-time recipient can remain ",[145,479,236],{}," while its documents render and until payment is completed. Check ",[145,482,483],{},"render_status"," and generated ",[145,486,487],{},"documents"," separately to determine whether previews are available. Filtering ",[145,490,393],{}," alone does not mean a recipient has finished rendering.",[166,493,495],{"id":494},"status-codes","Status codes",[171,497,498,508],{},[174,499,500],{},[177,501,502,505],{},[180,503,504],{},"Status",[180,506,507],{},"Meaning",[190,509,510,520,530,540],{},[177,511,512,517],{},[195,513,514],{},[145,515,516],{},"200",[195,518,519],{},"Array of matching recipients, possibly empty.",[177,521,522,527],{},[195,523,524],{},[145,525,526],{},"400",[195,528,529],{},"Invalid query parameters.",[177,531,532,537],{},[195,533,534],{},[145,535,536],{},"401",[195,538,539],{},"Missing or unauthorized API key.",[177,541,542,547],{},[195,543,544],{},[145,545,546],{},"500",[195,548,549],{},"Recipient listing failed.",[551,552,553],"style",{},"html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}",{"title":143,"searchDepth":157,"depth":157,"links":555},[556,557,558,559,560],{"id":168,"depth":157,"text":169},{"id":308,"depth":157,"text":309},{"id":437,"depth":157,"text":438},{"id":471,"depth":157,"text":472},{"id":494,"depth":157,"text":495},"List recipients with campaign, status, external ID and pagination filters.","md",null,{},true,{"title":83,"description":561},"d2QPV_f-bQ1_AwFkIhuEuzldDZqXjDSEM-axHlbQrhI",[569,571],{"title":79,"path":80,"stem":81,"description":570,"children":-1},"Render Scribeless handwriting text as a PNG.",{"title":87,"path":88,"stem":89,"description":572,"children":-1},"Upload up to 500 recipients with individual HTML and background rendering.",1791997865608]