[{"data":1,"prerenderedAt":891},["ShallowReactive",2],{"navigation_docs":3,"-campaigns-fetch-campaign":104,"-campaigns-fetch-campaign-surround":886},[4,26,32,45,70,87],{"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],{"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,"children":49,"page":25},"Recipients","\u002Frecipients","4.recipients",[50,54,58,62,66],{"title":51,"path":52,"stem":53},"Create recipients","\u002Frecipients\u002Fcreate-recipients","4.recipients\u002F1.create-recipients",{"title":55,"path":56,"stem":57},"Fetch recipient","\u002Frecipients\u002Ffetch-recipient","4.recipients\u002F2.fetch-recipient",{"title":59,"path":60,"stem":61},"Fetch recipient preview","\u002Frecipients\u002Ffetch-recipient-preview","4.recipients\u002F3.fetch-recipient-preview",{"title":63,"path":64,"stem":65},"Create HTML recipient","\u002Frecipients\u002Fcreate-html-recipient","4.recipients\u002F4.create-html-recipient",{"title":67,"path":68,"stem":69},"PNG API","\u002Frecipients\u002Fpng-api","4.recipients\u002F5.png-api",{"title":71,"path":72,"stem":73,"children":74,"page":25},"Partner Workflows","\u002Fpartner-workflows","5.partner-workflows",[75,79,83],{"title":76,"path":77,"stem":78},"Create partner team","\u002Fpartner-workflows\u002Fcreate-partner-team","5.partner-workflows\u002F1.create-partner-team",{"title":80,"path":81,"stem":82},"Account status","\u002Fpartner-workflows\u002Faccount-status","5.partner-workflows\u002F2.account-status",{"title":84,"path":85,"stem":86},"Checkout recipients","\u002Fpartner-workflows\u002Fcheckout-recipients","5.partner-workflows\u002F3.checkout-recipients",{"title":88,"path":89,"stem":90,"children":91,"page":25},"Webhooks","\u002Fwebhooks","6.webhooks",[92,96,100],{"title":93,"path":94,"stem":95},"Overview","\u002Fwebhooks\u002Foverview","6.webhooks\u002F0.overview",{"title":97,"path":98,"stem":99},"Manage subscriptions","\u002Fwebhooks\u002Fmanage-subscriptions","6.webhooks\u002F1.manage-subscriptions",{"title":101,"path":102,"stem":103},"QR scan events","\u002Fwebhooks\u002Fqr-code-scans","6.webhooks\u002F2.qr-code-scans",{"id":105,"title":42,"body":106,"description":879,"extension":880,"links":881,"meta":882,"navigation":883,"path":43,"seo":884,"stem":44,"__hash__":885},"docs\u002F3.campaigns\u002F2.fetch-campaign.md",{"type":107,"value":108,"toc":871},"minimark",[109,113,130,135,144,148,184,188,236,240,243,790,794,819,823,867],[110,111,112],"p",{},"Fetch a campaign when your integration needs to check campaign configuration, campaign status, recipient metrics, or the product\u002Ftemplate connected to a campaign.",[114,115,120],"pre",{"className":116,"code":117,"language":118,"meta":119,"style":119},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GET https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcampaigns\u002F{campaignId}\n","http","",[121,122,123],"code",{"__ignoreMap":119},[124,125,128],"span",{"class":126,"line":127},"line",1,[124,129,117],{},[131,132,134],"h2",{"id":133},"headers","Headers",[114,136,138],{"className":116,"code":137,"language":118,"meta":119,"style":119},"X-API-Key: YOUR_API_KEY\n",[121,139,140],{"__ignoreMap":119},[124,141,142],{"class":126,"line":127},[124,143,137],{},[131,145,147],{"id":146},"path-parameters","Path parameters",[149,150,151,167],"table",{},[152,153,154],"thead",{},[155,156,157,161,164],"tr",{},[158,159,160],"th",{},"Parameter",[158,162,163],{},"Type",[158,165,166],{},"Description",[168,169,170],"tbody",{},[155,171,172,178,181],{},[173,174,175],"td",{},[121,176,177],{},"campaignId",[173,179,180],{},"string",[173,182,183],{},"Scribeless campaign ID.",[131,185,187],{"id":186},"example-request","Example request",[114,189,193],{"className":190,"code":191,"language":192,"meta":119,"style":119},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --request GET 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcampaigns\u002FCAMPAIGN_ID' \\\n  --header 'X-API-Key: YOUR_API_KEY'\n","bash",[121,194,195,222],{"__ignoreMap":119},[124,196,197,201,205,208,212,215,218],{"class":126,"line":127},[124,198,200],{"class":199},"sBMFI","curl",[124,202,204],{"class":203},"sfazB"," --request",[124,206,207],{"class":203}," GET",[124,209,211],{"class":210},"sMK4o"," '",[124,213,214],{"class":203},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcampaigns\u002FCAMPAIGN_ID",[124,216,217],{"class":210},"'",[124,219,221],{"class":220},"sTEyZ"," \\\n",[124,223,225,228,230,233],{"class":126,"line":224},2,[124,226,227],{"class":203},"  --header",[124,229,211],{"class":210},[124,231,232],{"class":203},"X-API-Key: YOUR_API_KEY",[124,234,235],{"class":210},"'\n",[131,237,239],{"id":238},"response","Response",[110,241,242],{},"Successful requests return the campaign, its core configuration, product and template summary, recipient metrics, variables detected in the published template, and the latest rendered recipient where available.",[114,244,248],{"className":245,"code":246,"language":247,"meta":119,"style":119},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"id\": \"CAMPAIGN_ID\",\n  \"name\": \"API postcard campaign\",\n  \"status\": \"pending\",\n  \"delivery_method\": \"directMail\",\n  \"frequency\": \"oneTime\",\n  \"include_envelope\": false,\n  \"product\": {\n    \"id\": \"PRODUCT_ID\",\n    \"name\": \"A6 postcard\",\n    \"category\": \"postcard\",\n    \"standard\": \"ISO\"\n  },\n  \"template\": {\n    \"id\": \"TEMPLATE_ID\",\n    \"name\": \"Postcard template\"\n  },\n  \"latest_recipient\": {\n    \"id\": \"RECIPIENT_ID\"\n  },\n  \"metrics\": {\n    \"total\": 12,\n    \"pending\": 10,\n    \"ready\": 2,\n    \"printing\": 0,\n    \"shipped\": 0,\n    \"delivered\": 0,\n    \"deleted\": 0\n  },\n  \"variables\": [\n    {\n      \"id\": \"custom1\",\n      \"label\": \"Custom 1\"\n    }\n  ]\n}\n","json",[121,249,250,255,281,302,323,344,365,380,395,416,436,457,477,483,497,517,535,540,554,572,577,591,609,625,642,659,675,691,706,711,726,732,753,772,778,784],{"__ignoreMap":119},[124,251,252],{"class":126,"line":127},[124,253,254],{"class":210},"{\n",[124,256,257,260,264,267,270,273,276,278],{"class":126,"line":224},[124,258,259],{"class":210},"  \"",[124,261,263],{"class":262},"spNyl","id",[124,265,266],{"class":210},"\"",[124,268,269],{"class":210},":",[124,271,272],{"class":210}," \"",[124,274,275],{"class":203},"CAMPAIGN_ID",[124,277,266],{"class":210},[124,279,280],{"class":210},",\n",[124,282,284,286,289,291,293,295,298,300],{"class":126,"line":283},3,[124,285,259],{"class":210},[124,287,288],{"class":262},"name",[124,290,266],{"class":210},[124,292,269],{"class":210},[124,294,272],{"class":210},[124,296,297],{"class":203},"API postcard campaign",[124,299,266],{"class":210},[124,301,280],{"class":210},[124,303,305,307,310,312,314,316,319,321],{"class":126,"line":304},4,[124,306,259],{"class":210},[124,308,309],{"class":262},"status",[124,311,266],{"class":210},[124,313,269],{"class":210},[124,315,272],{"class":210},[124,317,318],{"class":203},"pending",[124,320,266],{"class":210},[124,322,280],{"class":210},[124,324,326,328,331,333,335,337,340,342],{"class":126,"line":325},5,[124,327,259],{"class":210},[124,329,330],{"class":262},"delivery_method",[124,332,266],{"class":210},[124,334,269],{"class":210},[124,336,272],{"class":210},[124,338,339],{"class":203},"directMail",[124,341,266],{"class":210},[124,343,280],{"class":210},[124,345,347,349,352,354,356,358,361,363],{"class":126,"line":346},6,[124,348,259],{"class":210},[124,350,351],{"class":262},"frequency",[124,353,266],{"class":210},[124,355,269],{"class":210},[124,357,272],{"class":210},[124,359,360],{"class":203},"oneTime",[124,362,266],{"class":210},[124,364,280],{"class":210},[124,366,368,370,373,375,377],{"class":126,"line":367},7,[124,369,259],{"class":210},[124,371,372],{"class":262},"include_envelope",[124,374,266],{"class":210},[124,376,269],{"class":210},[124,378,379],{"class":210}," false,\n",[124,381,383,385,388,390,392],{"class":126,"line":382},8,[124,384,259],{"class":210},[124,386,387],{"class":262},"product",[124,389,266],{"class":210},[124,391,269],{"class":210},[124,393,394],{"class":210}," {\n",[124,396,398,401,403,405,407,409,412,414],{"class":126,"line":397},9,[124,399,400],{"class":210},"    \"",[124,402,263],{"class":199},[124,404,266],{"class":210},[124,406,269],{"class":210},[124,408,272],{"class":210},[124,410,411],{"class":203},"PRODUCT_ID",[124,413,266],{"class":210},[124,415,280],{"class":210},[124,417,419,421,423,425,427,429,432,434],{"class":126,"line":418},10,[124,420,400],{"class":210},[124,422,288],{"class":199},[124,424,266],{"class":210},[124,426,269],{"class":210},[124,428,272],{"class":210},[124,430,431],{"class":203},"A6 postcard",[124,433,266],{"class":210},[124,435,280],{"class":210},[124,437,439,441,444,446,448,450,453,455],{"class":126,"line":438},11,[124,440,400],{"class":210},[124,442,443],{"class":199},"category",[124,445,266],{"class":210},[124,447,269],{"class":210},[124,449,272],{"class":210},[124,451,452],{"class":203},"postcard",[124,454,266],{"class":210},[124,456,280],{"class":210},[124,458,460,462,465,467,469,471,474],{"class":126,"line":459},12,[124,461,400],{"class":210},[124,463,464],{"class":199},"standard",[124,466,266],{"class":210},[124,468,269],{"class":210},[124,470,272],{"class":210},[124,472,473],{"class":203},"ISO",[124,475,476],{"class":210},"\"\n",[124,478,480],{"class":126,"line":479},13,[124,481,482],{"class":210},"  },\n",[124,484,486,488,491,493,495],{"class":126,"line":485},14,[124,487,259],{"class":210},[124,489,490],{"class":262},"template",[124,492,266],{"class":210},[124,494,269],{"class":210},[124,496,394],{"class":210},[124,498,500,502,504,506,508,510,513,515],{"class":126,"line":499},15,[124,501,400],{"class":210},[124,503,263],{"class":199},[124,505,266],{"class":210},[124,507,269],{"class":210},[124,509,272],{"class":210},[124,511,512],{"class":203},"TEMPLATE_ID",[124,514,266],{"class":210},[124,516,280],{"class":210},[124,518,520,522,524,526,528,530,533],{"class":126,"line":519},16,[124,521,400],{"class":210},[124,523,288],{"class":199},[124,525,266],{"class":210},[124,527,269],{"class":210},[124,529,272],{"class":210},[124,531,532],{"class":203},"Postcard template",[124,534,476],{"class":210},[124,536,538],{"class":126,"line":537},17,[124,539,482],{"class":210},[124,541,543,545,548,550,552],{"class":126,"line":542},18,[124,544,259],{"class":210},[124,546,547],{"class":262},"latest_recipient",[124,549,266],{"class":210},[124,551,269],{"class":210},[124,553,394],{"class":210},[124,555,557,559,561,563,565,567,570],{"class":126,"line":556},19,[124,558,400],{"class":210},[124,560,263],{"class":199},[124,562,266],{"class":210},[124,564,269],{"class":210},[124,566,272],{"class":210},[124,568,569],{"class":203},"RECIPIENT_ID",[124,571,476],{"class":210},[124,573,575],{"class":126,"line":574},20,[124,576,482],{"class":210},[124,578,580,582,585,587,589],{"class":126,"line":579},21,[124,581,259],{"class":210},[124,583,584],{"class":262},"metrics",[124,586,266],{"class":210},[124,588,269],{"class":210},[124,590,394],{"class":210},[124,592,594,596,599,601,603,607],{"class":126,"line":593},22,[124,595,400],{"class":210},[124,597,598],{"class":199},"total",[124,600,266],{"class":210},[124,602,269],{"class":210},[124,604,606],{"class":605},"sbssI"," 12",[124,608,280],{"class":210},[124,610,612,614,616,618,620,623],{"class":126,"line":611},23,[124,613,400],{"class":210},[124,615,318],{"class":199},[124,617,266],{"class":210},[124,619,269],{"class":210},[124,621,622],{"class":605}," 10",[124,624,280],{"class":210},[124,626,628,630,633,635,637,640],{"class":126,"line":627},24,[124,629,400],{"class":210},[124,631,632],{"class":199},"ready",[124,634,266],{"class":210},[124,636,269],{"class":210},[124,638,639],{"class":605}," 2",[124,641,280],{"class":210},[124,643,645,647,650,652,654,657],{"class":126,"line":644},25,[124,646,400],{"class":210},[124,648,649],{"class":199},"printing",[124,651,266],{"class":210},[124,653,269],{"class":210},[124,655,656],{"class":605}," 0",[124,658,280],{"class":210},[124,660,662,664,667,669,671,673],{"class":126,"line":661},26,[124,663,400],{"class":210},[124,665,666],{"class":199},"shipped",[124,668,266],{"class":210},[124,670,269],{"class":210},[124,672,656],{"class":605},[124,674,280],{"class":210},[124,676,678,680,683,685,687,689],{"class":126,"line":677},27,[124,679,400],{"class":210},[124,681,682],{"class":199},"delivered",[124,684,266],{"class":210},[124,686,269],{"class":210},[124,688,656],{"class":605},[124,690,280],{"class":210},[124,692,694,696,699,701,703],{"class":126,"line":693},28,[124,695,400],{"class":210},[124,697,698],{"class":199},"deleted",[124,700,266],{"class":210},[124,702,269],{"class":210},[124,704,705],{"class":605}," 0\n",[124,707,709],{"class":126,"line":708},29,[124,710,482],{"class":210},[124,712,714,716,719,721,723],{"class":126,"line":713},30,[124,715,259],{"class":210},[124,717,718],{"class":262},"variables",[124,720,266],{"class":210},[124,722,269],{"class":210},[124,724,725],{"class":210}," [\n",[124,727,729],{"class":126,"line":728},31,[124,730,731],{"class":210},"    {\n",[124,733,735,738,740,742,744,746,749,751],{"class":126,"line":734},32,[124,736,737],{"class":210},"      \"",[124,739,263],{"class":199},[124,741,266],{"class":210},[124,743,269],{"class":210},[124,745,272],{"class":210},[124,747,748],{"class":203},"custom1",[124,750,266],{"class":210},[124,752,280],{"class":210},[124,754,756,758,761,763,765,767,770],{"class":126,"line":755},33,[124,757,737],{"class":210},[124,759,760],{"class":199},"label",[124,762,266],{"class":210},[124,764,269],{"class":210},[124,766,272],{"class":210},[124,768,769],{"class":203},"Custom 1",[124,771,476],{"class":210},[124,773,775],{"class":126,"line":774},34,[124,776,777],{"class":210},"    }\n",[124,779,781],{"class":126,"line":780},35,[124,782,783],{"class":210},"  ]\n",[124,785,787],{"class":126,"line":786},36,[124,788,789],{"class":210},"}\n",[131,791,793],{"id":792},"notes","Notes",[795,796,797,801,806,812],"ul",{},[798,799,800],"li",{},"The response only includes campaigns your API key can access.",[798,802,803,805],{},[121,804,547],{}," is returned when Scribeless has a rendered recipient to show for the campaign.",[798,807,808,809,811],{},"Use ",[121,810,584],{}," when you need a quick campaign-level recipient count by status.",[798,813,814,815,818],{},"Treat any non-",[121,816,817],{},"2xx"," response as failed and inspect the response body for the error message.",[131,820,822],{"id":821},"status-codes","Status codes",[149,824,825,835],{},[152,826,827],{},[155,828,829,832],{},[158,830,831],{},"Status",[158,833,834],{},"Meaning",[168,836,837,847,857],{},[155,838,839,844],{},[173,840,841],{},[121,842,843],{},"200",[173,845,846],{},"Campaign found.",[155,848,849,854],{},[173,850,851],{},[121,852,853],{},"401",[173,855,856],{},"Missing, malformed, invalid, or unauthorized API key.",[155,858,859,864],{},[173,860,861],{},[121,862,863],{},"500",[173,865,866],{},"Campaign could not be fetched. Check the ID and retry, or contact support if it persists.",[868,869,870],"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}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":119,"searchDepth":224,"depth":224,"links":872},[873,874,875,876,877,878],{"id":133,"depth":224,"text":134},{"id":146,"depth":224,"text":147},{"id":186,"depth":224,"text":187},{"id":238,"depth":224,"text":239},{"id":792,"depth":224,"text":793},{"id":821,"depth":224,"text":822},"Get a Scribeless campaign by ID.","md",null,{},true,{"title":42,"description":879},"QPwHsp_t5i-zkUUDOVRWED5tUQgHuGGlkzK0scjdxII",[887,889],{"title":38,"path":39,"stem":40,"description":888,"children":-1},"Create a Scribeless campaign through the API.",{"title":51,"path":52,"stem":53,"description":890,"children":-1},"Create one or more recipients for a Scribeless campaign.",1780671947975]