[{"data":1,"prerenderedAt":760},["ShallowReactive",2],{"nav-docs":3,"nav-api":60,"api-transfers":89},[4],{"title":5,"path":6,"stem":7,"children":8},"Docs","\u002Fdocs","docs",[9,12,16,20,24,28,32,36,40,44,48,52,56],{"title":10,"path":6,"stem":11},"Installation","docs\u002Findex",{"title":13,"path":14,"stem":15},"Sending files","\u002Fdocs\u002Fsending-files","docs\u002F02.sending-files",{"title":17,"path":18,"stem":19},"Receiving files","\u002Fdocs\u002Freceiving-files","docs\u002F03.receiving-files",{"title":21,"path":22,"stem":23},"Passwords, galleries and backgrounds","\u002Fdocs\u002Fshare-options","docs\u002F04.share-options",{"title":25,"path":26,"stem":27},"Expiry and deletion","\u002Fdocs\u002Fexpiry","docs\u002F05.expiry",{"title":29,"path":30,"stem":31},"Users","\u002Fdocs\u002Fusers","docs\u002F06.users",{"title":33,"path":34,"stem":35},"Configuration","\u002Fdocs\u002Fconfiguration","docs\u002F07.configuration",{"title":37,"path":38,"stem":39},"Colours and branding","\u002Fdocs\u002Fcolors","docs\u002F08.colors",{"title":41,"path":42,"stem":43},"Docker","\u002Fdocs\u002Fdocker","docs\u002F09.docker",{"title":45,"path":46,"stem":47},"API keys","\u002Fdocs\u002Fapi-keys","docs\u002F10.api-keys",{"title":49,"path":50,"stem":51},"MCP server","\u002Fdocs\u002Fmcp-server","docs\u002F11.mcp-server",{"title":53,"path":54,"stem":55},"Troubleshooting","\u002Fdocs\u002Ftroubleshooting","docs\u002F12.troubleshooting",{"title":57,"path":58,"stem":59},"Contributing","\u002Fdocs\u002Fcontributing","docs\u002F13.contributing",[61],{"title":62,"path":63,"stem":64,"children":65},"Api","\u002Fapi","api",[66,69,73,77,81,85],{"title":67,"path":63,"stem":68},"REST API","api\u002Findex",{"title":70,"path":71,"stem":72},"Transfers","\u002Fapi\u002Ftransfers","api\u002F02.transfers",{"title":74,"path":75,"stem":76},"Uploading files","\u002Fapi\u002Fupload","api\u002F03.upload",{"title":78,"path":79,"stem":80},"Sending a transfer","\u002Fapi\u002Fsend","api\u002F04.send",{"title":82,"path":83,"stem":84},"Downloading","\u002Fapi\u002Fdownload","api\u002F05.download",{"title":86,"path":87,"stem":88},"Recipients","\u002Fapi\u002Frecipients","api\u002F06.recipients",{"id":90,"title":70,"body":91,"description":109,"extension":755,"meta":756,"navigation":757,"path":71,"seo":758,"stem":72,"__hash__":759},"api\u002Fapi\u002F02.transfers.md",{"type":92,"value":93,"toc":750},"minimark",[94,98,103,120,124,325,340,357,361,370,454,565,574,577,720,727,731,740,743,746],[95,96,70],"h1",{"id":97},"transfers",[99,100,102],"h2",{"id":101},"list-transfers","List transfers",[104,105,110],"pre",{"className":106,"code":107,"language":108,"meta":109,"style":109},"language-http shiki shiki-themes github-light github-dark","GET \u002Fapi\u002Ftransfers\n","http","",[111,112,113],"code",{"__ignoreMap":109},[114,115,118],"span",{"class":116,"line":117},"line",1,[114,119,107],{},[121,122,123],"p",{},"Returns both directions in one response.",[104,125,129],{"className":126,"code":127,"language":128,"meta":109,"style":109},"language-json shiki shiki-themes github-light github-dark","{\n  \"data\": {\n    \"sent\": [\n      {\n        \"id\": 12,\n        \"token\": \"3f9a…\",\n        \"subject\": \"Proposal & draft contract\",\n        \"status\": \"sent\",\n        \"kind\": \"outgoing\",\n        \"expiresAt\": \"2026-09-01T10:00:00.000Z\",\n        \"downloadCount\": 3,\n        \"fileCount\": 3,\n        \"totalSize\": 574464,\n        \"recipients\": \"client@example.com, anna@example.com\"\n      }\n    ],\n    \"received\": []\n  }\n}\n","json",[111,130,131,137,147,156,162,177,191,204,217,230,243,256,268,281,292,298,304,313,319],{"__ignoreMap":109},[114,132,133],{"class":116,"line":117},[114,134,136],{"class":135},"sVt8B","{\n",[114,138,140,144],{"class":116,"line":139},2,[114,141,143],{"class":142},"sj4cs","  \"data\"",[114,145,146],{"class":135},": {\n",[114,148,150,153],{"class":116,"line":149},3,[114,151,152],{"class":142},"    \"sent\"",[114,154,155],{"class":135},": [\n",[114,157,159],{"class":116,"line":158},4,[114,160,161],{"class":135},"      {\n",[114,163,165,168,171,174],{"class":116,"line":164},5,[114,166,167],{"class":142},"        \"id\"",[114,169,170],{"class":135},": ",[114,172,173],{"class":142},"12",[114,175,176],{"class":135},",\n",[114,178,180,183,185,189],{"class":116,"line":179},6,[114,181,182],{"class":142},"        \"token\"",[114,184,170],{"class":135},[114,186,188],{"class":187},"sZZnC","\"3f9a…\"",[114,190,176],{"class":135},[114,192,194,197,199,202],{"class":116,"line":193},7,[114,195,196],{"class":142},"        \"subject\"",[114,198,170],{"class":135},[114,200,201],{"class":187},"\"Proposal & draft contract\"",[114,203,176],{"class":135},[114,205,207,210,212,215],{"class":116,"line":206},8,[114,208,209],{"class":142},"        \"status\"",[114,211,170],{"class":135},[114,213,214],{"class":187},"\"sent\"",[114,216,176],{"class":135},[114,218,220,223,225,228],{"class":116,"line":219},9,[114,221,222],{"class":142},"        \"kind\"",[114,224,170],{"class":135},[114,226,227],{"class":187},"\"outgoing\"",[114,229,176],{"class":135},[114,231,233,236,238,241],{"class":116,"line":232},10,[114,234,235],{"class":142},"        \"expiresAt\"",[114,237,170],{"class":135},[114,239,240],{"class":187},"\"2026-09-01T10:00:00.000Z\"",[114,242,176],{"class":135},[114,244,246,249,251,254],{"class":116,"line":245},11,[114,247,248],{"class":142},"        \"downloadCount\"",[114,250,170],{"class":135},[114,252,253],{"class":142},"3",[114,255,176],{"class":135},[114,257,259,262,264,266],{"class":116,"line":258},12,[114,260,261],{"class":142},"        \"fileCount\"",[114,263,170],{"class":135},[114,265,253],{"class":142},[114,267,176],{"class":135},[114,269,271,274,276,279],{"class":116,"line":270},13,[114,272,273],{"class":142},"        \"totalSize\"",[114,275,170],{"class":135},[114,277,278],{"class":142},"574464",[114,280,176],{"class":135},[114,282,284,287,289],{"class":116,"line":283},14,[114,285,286],{"class":142},"        \"recipients\"",[114,288,170],{"class":135},[114,290,291],{"class":187},"\"client@example.com, anna@example.com\"\n",[114,293,295],{"class":116,"line":294},15,[114,296,297],{"class":135},"      }\n",[114,299,301],{"class":116,"line":300},16,[114,302,303],{"class":135},"    ],\n",[114,305,307,310],{"class":116,"line":306},17,[114,308,309],{"class":142},"    \"received\"",[114,311,312],{"class":135},": []\n",[114,314,316],{"class":116,"line":315},18,[114,317,318],{"class":135},"  }\n",[114,320,322],{"class":116,"line":321},19,[114,323,324],{"class":135},"}\n",[121,326,327,330,331,334,335,339],{},[111,328,329],{},"sent"," matches on your user id. ",[111,332,333],{},"received"," matches on your ",[336,337,338],"strong",{},"e-mail address",",\nbecause a transfer can be addressed to someone before they have an account, or\nby an outside sender who only ever knew the address.",[121,341,342,345,346,349,350,345,353,356],{},[111,343,344],{},"status"," is ",[111,347,348],{},"draft"," until the transfer is sent. ",[111,351,352],{},"kind",[111,354,355],{},"guest"," when an outside\ncontact uploaded it to a team member.",[99,358,360],{"id":359},"create-a-draft","Create a draft",[104,362,364],{"className":106,"code":363,"language":108,"meta":109,"style":109},"POST \u002Fapi\u002Ftransfers\n",[111,365,366],{"__ignoreMap":109},[114,367,368],{"class":116,"line":117},[114,369,363],{},[104,371,373],{"className":126,"code":372,"language":128,"meta":109,"style":109},"{\n  \"recipients\": [\"client@example.com\"],\n  \"subject\": \"Proposal & draft contract\",\n  \"message\": \"As discussed — feedback by Friday would be great.\",\n  \"retentionDays\": 7,\n  \"password\": \"optional\",\n  \"layout\": \"list\"\n}\n",[111,374,375,379,393,404,416,428,440,450],{"__ignoreMap":109},[114,376,377],{"class":116,"line":117},[114,378,136],{"class":135},[114,380,381,384,387,390],{"class":116,"line":139},[114,382,383],{"class":142},"  \"recipients\"",[114,385,386],{"class":135},": [",[114,388,389],{"class":187},"\"client@example.com\"",[114,391,392],{"class":135},"],\n",[114,394,395,398,400,402],{"class":116,"line":149},[114,396,397],{"class":142},"  \"subject\"",[114,399,170],{"class":135},[114,401,201],{"class":187},[114,403,176],{"class":135},[114,405,406,409,411,414],{"class":116,"line":158},[114,407,408],{"class":142},"  \"message\"",[114,410,170],{"class":135},[114,412,413],{"class":187},"\"As discussed — feedback by Friday would be great.\"",[114,415,176],{"class":135},[114,417,418,421,423,426],{"class":116,"line":164},[114,419,420],{"class":142},"  \"retentionDays\"",[114,422,170],{"class":135},[114,424,425],{"class":142},"7",[114,427,176],{"class":135},[114,429,430,433,435,438],{"class":116,"line":179},[114,431,432],{"class":142},"  \"password\"",[114,434,170],{"class":135},[114,436,437],{"class":187},"\"optional\"",[114,439,176],{"class":135},[114,441,442,445,447],{"class":116,"line":193},[114,443,444],{"class":142},"  \"layout\"",[114,446,170],{"class":135},[114,448,449],{"class":187},"\"list\"\n",[114,451,452],{"class":116,"line":206},[114,453,324],{"class":135},[455,456,457,470],"table",{},[458,459,460],"thead",{},[461,462,463,467],"tr",{},[464,465,466],"th",{},"Field",[464,468,469],{},"Notes",[471,472,473,488,498,508,526,536,552],"tbody",{},[461,474,475,481],{},[476,477,478],"td",{},[111,479,480],{},"recipients",[476,482,483,484,487],{},"Up to 25 addresses. Omit or pass ",[111,485,486],{},"[]"," for a link-only transfer",[461,489,490,495],{},[476,491,492],{},[111,493,494],{},"subject",[476,496,497],{},"Up to 255 characters",[461,499,500,505],{},[476,501,502],{},[111,503,504],{},"message",[476,506,507],{},"Up to 5000 characters",[461,509,510,515],{},[476,511,512],{},[111,513,514],{},"retentionDays",[476,516,517,518,521,522,525],{},"One of ",[111,519,520],{},"1, 3, 7, 14, 30, 60, 90, 0","; ",[111,523,524],{},"0"," means no expiry",[461,527,528,533],{},[476,529,530],{},[111,531,532],{},"password",[476,534,535],{},"At least 4 characters; not included in the e-mail",[461,537,538,543],{},[476,539,540],{},[111,541,542],{},"layout",[476,544,545,548,549],{},[111,546,547],{},"list"," or ",[111,550,551],{},"gallery",[461,553,554,559],{},[476,555,556],{},[111,557,558],{},"useDefaultBackground",[476,560,561,564],{},[111,562,563],{},"false"," leaves the sender's default background off this transfer; omitted, it is applied",[121,566,567,569,570,573],{},[111,568,514],{}," is validated before it is coerced, so a missing or blank value\nis a ",[111,571,572],{},"400"," rather than silently becoming \"keep forever\".",[121,575,576],{},"The response carries the id and the download token, so you can copy the link\nwithout a second request:",[104,578,580],{"className":126,"code":579,"language":128,"meta":109,"style":109},"{\n  \"data\": {\n    \"id\": 12,\n    \"token\": \"3f9a…\",\n    \"status\": \"draft\",\n    \"retentionDays\": 7,\n    \"expiresAt\": \"2026-09-01T10:00:00.000Z\",\n    \"layout\": \"list\",\n    \"hasPassword\": false,\n    \"hasBackground\": true,\n    \"recipients\": [{ \"email\": \"client@example.com\", \"name\": null }]\n  }\n}\n",[111,581,582,586,592,603,614,626,637,648,660,671,683,712,716],{"__ignoreMap":109},[114,583,584],{"class":116,"line":117},[114,585,136],{"class":135},[114,587,588,590],{"class":116,"line":139},[114,589,143],{"class":142},[114,591,146],{"class":135},[114,593,594,597,599,601],{"class":116,"line":149},[114,595,596],{"class":142},"    \"id\"",[114,598,170],{"class":135},[114,600,173],{"class":142},[114,602,176],{"class":135},[114,604,605,608,610,612],{"class":116,"line":158},[114,606,607],{"class":142},"    \"token\"",[114,609,170],{"class":135},[114,611,188],{"class":187},[114,613,176],{"class":135},[114,615,616,619,621,624],{"class":116,"line":164},[114,617,618],{"class":142},"    \"status\"",[114,620,170],{"class":135},[114,622,623],{"class":187},"\"draft\"",[114,625,176],{"class":135},[114,627,628,631,633,635],{"class":116,"line":179},[114,629,630],{"class":142},"    \"retentionDays\"",[114,632,170],{"class":135},[114,634,425],{"class":142},[114,636,176],{"class":135},[114,638,639,642,644,646],{"class":116,"line":193},[114,640,641],{"class":142},"    \"expiresAt\"",[114,643,170],{"class":135},[114,645,240],{"class":187},[114,647,176],{"class":135},[114,649,650,653,655,658],{"class":116,"line":206},[114,651,652],{"class":142},"    \"layout\"",[114,654,170],{"class":135},[114,656,657],{"class":187},"\"list\"",[114,659,176],{"class":135},[114,661,662,665,667,669],{"class":116,"line":219},[114,663,664],{"class":142},"    \"hasPassword\"",[114,666,170],{"class":135},[114,668,563],{"class":142},[114,670,176],{"class":135},[114,672,673,676,678,681],{"class":116,"line":232},[114,674,675],{"class":142},"    \"hasBackground\"",[114,677,170],{"class":135},[114,679,680],{"class":142},"true",[114,682,176],{"class":135},[114,684,685,688,691,694,696,698,701,704,706,709],{"class":116,"line":245},[114,686,687],{"class":142},"    \"recipients\"",[114,689,690],{"class":135},": [{ ",[114,692,693],{"class":142},"\"email\"",[114,695,170],{"class":135},[114,697,389],{"class":187},[114,699,700],{"class":135},", ",[114,702,703],{"class":142},"\"name\"",[114,705,170],{"class":135},[114,707,708],{"class":142},"null",[114,710,711],{"class":135}," }]\n",[114,713,714],{"class":116,"line":258},[114,715,318],{"class":135},[114,717,718],{"class":116,"line":270},[114,719,324],{"class":135},[121,721,722,723,726],{},"The password itself is never echoed back — only whether one is set.\n",[111,724,725],{},"hasBackground"," says whether the sender's default background was put on the\ndraft; the transfer keeps its own copy of it.",[99,728,730],{"id":729},"delete-a-transfer","Delete a transfer",[104,732,734],{"className":106,"code":733,"language":108,"meta":109,"style":109},"DELETE \u002Fapi\u002Ftransfers\u002F:id\n",[111,735,736],{"__ignoreMap":109},[114,737,738],{"class":116,"line":117},[114,739,733],{},[121,741,742],{},"The manual version of expiry. Files go from disk and the rows go with them, so\nany link already sitting in an inbox stops working. This cannot be undone.",[121,744,745],{},"Administrators can delete anyone's transfer through the interface; over the API\na key can only delete its own account's.",[747,748,749],"style",{},"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 .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}",{"title":109,"searchDepth":139,"depth":139,"links":751},[752,753,754],{"id":101,"depth":139,"text":102},{"id":359,"depth":139,"text":360},{"id":729,"depth":139,"text":730},"md",{},true,{"title":70,"description":109},"GmR2kH9kQpd5IDFOLZztmXjbwXWUxcELix3uqorwe5E",1790104591923]