[{"data":1,"prerenderedAt":475},["ShallowReactive",2],{"navigation_docs":3,"-address-finder-usage":157,"-address-finder-usage-surround":472},[4,26,32,53,90,107,136],{"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,103],{"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},"Prepaid credit","\u002Fpartner-workflows\u002Fprepaid-credit","5.partner-workflows\u002F3.prepaid-credit",{"title":108,"path":109,"stem":110,"children":111,"page":25},"Webhooks","\u002Fwebhooks","6.webhooks",[112,116,120,124,128,132],{"title":113,"path":114,"stem":115},"Overview","\u002Fwebhooks\u002Foverview","6.webhooks\u002F0.overview",{"title":117,"path":118,"stem":119},"Manage subscriptions","\u002Fwebhooks\u002Fmanage-subscriptions","6.webhooks\u002F1.manage-subscriptions",{"title":121,"path":122,"stem":123},"Recipient events","\u002Fwebhooks\u002Frecipient-events","6.webhooks\u002F2.recipient-events",{"title":125,"path":126,"stem":127},"QR scan events","\u002Fwebhooks\u002Fqr-code-scans","6.webhooks\u002F3.qr-code-scans",{"title":129,"path":130,"stem":131},"Receive deliveries","\u002Fwebhooks\u002Freceive-deliveries","6.webhooks\u002F4.receive-deliveries",{"title":133,"path":134,"stem":135},"Test and resend","\u002Fwebhooks\u002Ftest-and-resend","6.webhooks\u002F5.test-and-resend",{"title":137,"path":138,"stem":139,"children":140,"page":25},"Address Finder","\u002Faddress-finder","7.address-finder",[141,145,149,153],{"title":142,"path":143,"stem":144},"Find an address","\u002Faddress-finder\u002Ffind-address","7.address-finder\u002F1.find-address",{"title":146,"path":147,"stem":148},"Fetch lookup","\u002Faddress-finder\u002Ffetch-lookup","7.address-finder\u002F2.fetch-lookup",{"title":150,"path":151,"stem":152},"List lookups","\u002Faddress-finder\u002Flist-lookups","7.address-finder\u002F3.list-lookups",{"title":154,"path":155,"stem":156},"Usage","\u002Faddress-finder\u002Fusage","7.address-finder\u002F4.usage",{"id":158,"title":154,"body":159,"description":465,"extension":466,"links":467,"meta":468,"navigation":469,"path":155,"seo":470,"stem":156,"__hash__":471},"docs\u002F7.address-finder\u002F4.usage.md",{"type":160,"value":161,"toc":458},"minimark",[162,166,183,188,197,201,249,253,325,329,393,396,400,454],[163,164,165],"p",{},"Check how many lookups your team has used and has left.",[167,168,173],"pre",{"className":169,"code":170,"language":171,"meta":172,"style":172},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GET https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Faddress-finder\u002Fusage\n","http","",[174,175,176],"code",{"__ignoreMap":172},[177,178,181],"span",{"class":179,"line":180},"line",1,[177,182,170],{},[184,185,187],"h2",{"id":186},"headers","Headers",[167,189,191],{"className":169,"code":190,"language":171,"meta":172,"style":172},"X-API-Key: YOUR_API_KEY\n",[174,192,193],{"__ignoreMap":172},[177,194,195],{"class":179,"line":180},[177,196,190],{},[184,198,200],{"id":199},"example-request","Example request",[167,202,206],{"className":203,"code":204,"language":205,"meta":172,"style":172},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --request GET 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Faddress-finder\u002Fusage' \\\n  --header 'X-API-Key: YOUR_API_KEY'\n","bash",[174,207,208,235],{"__ignoreMap":172},[177,209,210,214,218,221,225,228,231],{"class":179,"line":180},[177,211,213],{"class":212},"sBMFI","curl",[177,215,217],{"class":216},"sfazB"," --request",[177,219,220],{"class":216}," GET",[177,222,224],{"class":223},"sMK4o"," '",[177,226,227],{"class":216},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Faddress-finder\u002Fusage",[177,229,230],{"class":223},"'",[177,232,234],{"class":233},"sTEyZ"," \\\n",[177,236,238,241,243,246],{"class":179,"line":237},2,[177,239,240],{"class":216},"  --header",[177,242,224],{"class":223},[177,244,245],{"class":216},"X-API-Key: YOUR_API_KEY",[177,247,248],{"class":223},"'\n",[184,250,252],{"id":251},"response","Response",[167,254,258],{"className":255,"code":256,"language":257,"meta":172,"style":172},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"used\": 42,\n  \"limit\": 100,\n  \"remaining\": 58\n}\n","json",[174,259,260,265,287,304,319],{"__ignoreMap":172},[177,261,262],{"class":179,"line":180},[177,263,264],{"class":223},"{\n",[177,266,267,270,274,277,280,284],{"class":179,"line":237},[177,268,269],{"class":223},"  \"",[177,271,273],{"class":272},"spNyl","used",[177,275,276],{"class":223},"\"",[177,278,279],{"class":223},":",[177,281,283],{"class":282},"sbssI"," 42",[177,285,286],{"class":223},",\n",[177,288,290,292,295,297,299,302],{"class":179,"line":289},3,[177,291,269],{"class":223},[177,293,294],{"class":272},"limit",[177,296,276],{"class":223},[177,298,279],{"class":223},[177,300,301],{"class":282}," 100",[177,303,286],{"class":223},[177,305,307,309,312,314,316],{"class":179,"line":306},4,[177,308,269],{"class":223},[177,310,311],{"class":272},"remaining",[177,313,276],{"class":223},[177,315,279],{"class":223},[177,317,318],{"class":282}," 58\n",[177,320,322],{"class":179,"line":321},5,[177,323,324],{"class":223},"}\n",[184,326,328],{"id":327},"fields","Fields",[330,331,332,348],"table",{},[333,334,335],"thead",{},[336,337,338,342,345],"tr",{},[339,340,341],"th",{},"Field",[339,343,344],{},"Type",[339,346,347],{},"Description",[349,350,351,364,380],"tbody",{},[336,352,353,358,361],{},[354,355,356],"td",{},[174,357,273],{},[354,359,360],{},"number",[354,362,363],{},"All lookups your team has made.",[336,365,366,370,373],{},[354,367,368],{},[174,369,294],{},[354,371,372],{},"number or null",[354,374,375,376,379],{},"Your team's total lookup limit, or ",[174,377,378],{},"null"," when there is no limit.",[336,381,382,386,388],{},[354,383,384],{},[174,385,311],{},[354,387,372],{},[354,389,390,391,379],{},"Lookups left, or ",[174,392,378],{},[163,394,395],{},"The limit is a total. It does not reset each month. Contact the Scribeless team to add more lookups.",[184,397,399],{"id":398},"status-codes","Status codes",[330,401,402,412],{},[333,403,404],{},[336,405,406,409],{},[339,407,408],{},"Status",[339,410,411],{},"Meaning",[349,413,414,424,434,444],{},[336,415,416,421],{},[354,417,418],{},[174,419,420],{},"200",[354,422,423],{},"Usage returned.",[336,425,426,431],{},[354,427,428],{},[174,429,430],{},"401",[354,432,433],{},"Missing, malformed, invalid, or unauthorized API key.",[336,435,436,441],{},[354,437,438],{},[174,439,440],{},"403",[354,442,443],{},"Address Finder is not enabled for your team.",[336,445,446,451],{},[354,447,448],{},[174,449,450],{},"502",[354,452,453],{},"Address Finder is temporarily unavailable. Retry later.",[455,456,457],"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":172,"searchDepth":237,"depth":237,"links":459},[460,461,462,463,464],{"id":186,"depth":237,"text":187},{"id":199,"depth":237,"text":200},{"id":251,"depth":237,"text":252},{"id":327,"depth":237,"text":328},{"id":398,"depth":237,"text":399},"Check how many Address Finder lookups your team has used and has left.","md",null,{},true,{"title":154,"description":465},"ahbE-Or3LEpff3Fq7-oPbn0UkFspOGdeLoMtL_7s7XU",[473,467],{"title":150,"path":151,"stem":152,"description":474,"children":-1},"List your team's most recent Address Finder lookups.",1794418776043]