[{"data":1,"prerenderedAt":1007},["ShallowReactive",2],{"navigationApi":3,"api_board":52},[4],{"title":5,"path":6,"stem":7,"children":8},"Api","\u002Fapi","api",[9,12,16,20,24,28,32,36,40,44,48],{"title":10,"path":6,"stem":11},"Authentification","api\u002Findex",{"title":13,"path":14,"stem":15},"Area","\u002Fapi\u002Farea","api\u002Farea",{"title":17,"path":18,"stem":19},"Areas","\u002Fapi\u002Fareas","api\u002Fareas",{"title":21,"path":22,"stem":23},"Board","\u002Fapi\u002Fboard","api\u002Fboard",{"title":25,"path":26,"stem":27},"Boards","\u002Fapi\u002Fboards","api\u002Fboards",{"title":29,"path":30,"stem":31},"Card","\u002Fapi\u002Fcard","api\u002Fcard",{"title":33,"path":34,"stem":35},"Cards","\u002Fapi\u002Fcards","api\u002Fcards",{"title":37,"path":38,"stem":39},"Comment","\u002Fapi\u002Fcomment","api\u002Fcomment",{"title":41,"path":42,"stem":43},"Invite","\u002Fapi\u002Finvite","api\u002Finvite",{"title":45,"path":46,"stem":47},"Move a card","\u002Fapi\u002Fcardmove","api\u002FcardMove",{"title":49,"path":50,"stem":51},"Order card","\u002Fapi\u002Fcardorder","api\u002FcardOrder",{"id":53,"title":21,"body":54,"description":1002,"extension":1003,"meta":1004,"navigation":381,"path":22,"seo":1005,"stem":23,"__hash__":1006},"api\u002Fapi\u002Fboard.md",{"type":55,"value":56,"toc":973},"minimark",[57,61,70,75,78,83,99,103,126,130,267,271,294,298,301,304,354,358,435,439,520,523,615,618,640,644,647,650,662,665,679,682,705,708,728,732,735,738,752,755,874,877,899,902,924,928,935,939,970],[58,59,21],"h1",{"id":60},"board",[62,63,64,65,69],"p",{},"The ",[66,67,68],"code",{},"api\u002Fdata\u002Fboard"," endpoint is used to manage boards. It supports retrieving, creating, updating, and deleting boards, as well as updating the order of areas within a board.",[71,72,74],"h2",{"id":73},"get-method","GET Method",[62,76,77],{},"Fetches details of a specific board.",[79,80,82],"h3",{"id":81},"parameters","Parameters",[84,85,86,93],"ul",{},[87,88,89,92],"li",{},[66,90,91],{},"id"," (required): The ID of the board to fetch.",[87,94,95,98],{},[66,96,97],{},"userId"," (required): The ID of the user requesting the board.",[79,100,102],{"id":101},"example-request","Example Request",[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\u002Fdata\u002Fboard?id=123&userId=456\nX-API-Key: your_api_key_here\n","http","",[66,111,112,120],{"__ignoreMap":109},[113,114,117],"span",{"class":115,"line":116},"line",1,[113,118,119],{},"GET \u002Fapi\u002Fdata\u002Fboard?id=123&userId=456\n",[113,121,123],{"class":115,"line":122},2,[113,124,125],{},"X-API-Key: your_api_key_here\n",[79,127,129],{"id":128},"example-response-success","Example Response (Success)",[104,131,135],{"className":132,"code":133,"language":134,"meta":109,"style":109},"language-json shiki shiki-themes github-light github-dark","{\n  \"board\": {\n    \"id\": 123,\n    \"user\": 456,\n    \"name\": \"Board Name\",\n    \"style\": \"kanban\",\n    \"image\": \"board_image_url\",\n    \"color\": \"#2563eb\",\n    \"status\": \"public\"\n  },\n  \"writeAccess\": true\n}\n","json",[66,136,137,143,152,167,180,194,207,220,233,244,250,261],{"__ignoreMap":109},[113,138,139],{"class":115,"line":116},[113,140,142],{"class":141},"sVt8B","{\n",[113,144,145,149],{"class":115,"line":122},[113,146,148],{"class":147},"sj4cs","  \"board\"",[113,150,151],{"class":141},": {\n",[113,153,155,158,161,164],{"class":115,"line":154},3,[113,156,157],{"class":147},"    \"id\"",[113,159,160],{"class":141},": ",[113,162,163],{"class":147},"123",[113,165,166],{"class":141},",\n",[113,168,170,173,175,178],{"class":115,"line":169},4,[113,171,172],{"class":147},"    \"user\"",[113,174,160],{"class":141},[113,176,177],{"class":147},"456",[113,179,166],{"class":141},[113,181,183,186,188,192],{"class":115,"line":182},5,[113,184,185],{"class":147},"    \"name\"",[113,187,160],{"class":141},[113,189,191],{"class":190},"sZZnC","\"Board Name\"",[113,193,166],{"class":141},[113,195,197,200,202,205],{"class":115,"line":196},6,[113,198,199],{"class":147},"    \"style\"",[113,201,160],{"class":141},[113,203,204],{"class":190},"\"kanban\"",[113,206,166],{"class":141},[113,208,210,213,215,218],{"class":115,"line":209},7,[113,211,212],{"class":147},"    \"image\"",[113,214,160],{"class":141},[113,216,217],{"class":190},"\"board_image_url\"",[113,219,166],{"class":141},[113,221,223,226,228,231],{"class":115,"line":222},8,[113,224,225],{"class":147},"    \"color\"",[113,227,160],{"class":141},[113,229,230],{"class":190},"\"#2563eb\"",[113,232,166],{"class":141},[113,234,236,239,241],{"class":115,"line":235},9,[113,237,238],{"class":147},"    \"status\"",[113,240,160],{"class":141},[113,242,243],{"class":190},"\"public\"\n",[113,245,247],{"class":115,"line":246},10,[113,248,249],{"class":141},"  },\n",[113,251,253,256,258],{"class":115,"line":252},11,[113,254,255],{"class":147},"  \"writeAccess\"",[113,257,160],{"class":141},[113,259,260],{"class":147},"true\n",[113,262,264],{"class":115,"line":263},12,[113,265,266],{"class":141},"}\n",[79,268,270],{"id":269},"example-response-error","Example Response (Error)",[104,272,274],{"className":132,"code":273,"language":134,"meta":109,"style":109},"{\n  \"error\": \"Board not found\"\n}\n",[66,275,276,280,290],{"__ignoreMap":109},[113,277,278],{"class":115,"line":116},[113,279,142],{"class":141},[113,281,282,285,287],{"class":115,"line":122},[113,283,284],{"class":147},"  \"error\"",[113,286,160],{"class":141},[113,288,289],{"class":190},"\"Board not found\"\n",[113,291,292],{"class":115,"line":154},[113,293,266],{"class":141},[71,295,297],{"id":296},"post-method","POST Method",[62,299,300],{},"Creates a new board or updates an existing board.",[79,302,82],{"id":303},"parameters-1",[84,305,306,311,316,322,328,334,348],{},[87,307,308,310],{},[66,309,91],{}," (optional): The ID of the board to update. If not provided, a new board will be created.",[87,312,313,315],{},[66,314,97],{}," (required): The ID of the user creating or updating the board.",[87,317,318,321],{},[66,319,320],{},"name"," (required): The name of the board.",[87,323,324,327],{},[66,325,326],{},"style"," (required): The style of the board. Can be set to \"kanban\" or \"todo\".",[87,329,330,333],{},[66,331,332],{},"image"," (optional): The image URL for the board.",[87,335,336,339,340,343,344,347],{},[66,337,338],{},"color"," (optional): The tile colour as a hex value, e.g. ",[66,341,342],{},"#2563eb",". Anything that is not a hex colour — including an empty string — is stored as ",[66,345,346],{},"null",", which means the tile uses the instance's primary colour. A cover image covers the tile, so a board shows either an image or a colour.",[87,349,350,353],{},[66,351,352],{},"status"," (required): The status of the board (e.g., \"public\" or \"private\").",[79,355,357],{"id":356},"example-request-create","Example Request (Create)",[104,359,361],{"className":132,"code":360,"language":134,"meta":109,"style":109},"POST \u002Fapi\u002Fdata\u002Fboard\nContent-Type: application\u002Fjson\nX-API-Key: your_api_key_here\n\n{\n  \"userId\": 456,\n  \"name\": \"New Board\",\n  \"style\": \"board_style\",\n  \"status\": \"public\"\n}\n",[66,362,363,368,373,377,383,387,398,410,422,431],{"__ignoreMap":109},[113,364,365],{"class":115,"line":116},[113,366,367],{"class":141},"POST \u002Fapi\u002Fdata\u002Fboard\n",[113,369,370],{"class":115,"line":122},[113,371,372],{"class":141},"Content-Type: application\u002Fjson\n",[113,374,375],{"class":115,"line":154},[113,376,125],{"class":141},[113,378,379],{"class":115,"line":169},[113,380,382],{"emptyLinePlaceholder":381},true,"\n",[113,384,385],{"class":115,"line":182},[113,386,142],{"class":141},[113,388,389,392,394,396],{"class":115,"line":196},[113,390,391],{"class":147},"  \"userId\"",[113,393,160],{"class":141},[113,395,177],{"class":147},[113,397,166],{"class":141},[113,399,400,403,405,408],{"class":115,"line":209},[113,401,402],{"class":147},"  \"name\"",[113,404,160],{"class":141},[113,406,407],{"class":190},"\"New Board\"",[113,409,166],{"class":141},[113,411,412,415,417,420],{"class":115,"line":222},[113,413,414],{"class":147},"  \"style\"",[113,416,160],{"class":141},[113,418,419],{"class":190},"\"board_style\"",[113,421,166],{"class":141},[113,423,424,427,429],{"class":115,"line":235},[113,425,426],{"class":147},"  \"status\"",[113,428,160],{"class":141},[113,430,243],{"class":190},[113,432,433],{"class":115,"line":246},[113,434,266],{"class":141},[79,436,438],{"id":437},"example-request-update","Example Request (Update)",[104,440,442],{"className":132,"code":441,"language":134,"meta":109,"style":109},"POST \u002Fapi\u002Fdata\u002Fboard\nContent-Type: application\u002Fjson\nX-API-Key: your_api_key_here\n\n{\n  \"id\": 123,\n  \"userId\": 456,\n  \"name\": \"Updated Board\",\n  \"style\": \"todo\",\n  \"status\": \"private\"\n}\n",[66,443,444,448,452,456,460,464,475,485,496,507,516],{"__ignoreMap":109},[113,445,446],{"class":115,"line":116},[113,447,367],{"class":141},[113,449,450],{"class":115,"line":122},[113,451,372],{"class":141},[113,453,454],{"class":115,"line":154},[113,455,125],{"class":141},[113,457,458],{"class":115,"line":169},[113,459,382],{"emptyLinePlaceholder":381},[113,461,462],{"class":115,"line":182},[113,463,142],{"class":141},[113,465,466,469,471,473],{"class":115,"line":196},[113,467,468],{"class":147},"  \"id\"",[113,470,160],{"class":141},[113,472,163],{"class":147},[113,474,166],{"class":141},[113,476,477,479,481,483],{"class":115,"line":209},[113,478,391],{"class":147},[113,480,160],{"class":141},[113,482,177],{"class":147},[113,484,166],{"class":141},[113,486,487,489,491,494],{"class":115,"line":222},[113,488,402],{"class":147},[113,490,160],{"class":141},[113,492,493],{"class":190},"\"Updated Board\"",[113,495,166],{"class":141},[113,497,498,500,502,505],{"class":115,"line":235},[113,499,414],{"class":147},[113,501,160],{"class":141},[113,503,504],{"class":190},"\"todo\"",[113,506,166],{"class":141},[113,508,509,511,513],{"class":115,"line":246},[113,510,426],{"class":147},[113,512,160],{"class":141},[113,514,515],{"class":190},"\"private\"\n",[113,517,518],{"class":115,"line":252},[113,519,266],{"class":141},[79,521,129],{"id":522},"example-response-success-1",[104,524,526],{"className":132,"code":525,"language":134,"meta":109,"style":109},"{\n  \"board\": {\n    \"id\": 123,\n    \"user\": 456,\n    \"name\": \"Board Name\",\n    \"style\": \"kanban\",\n    \"image\": \"board_image_url\",\n    \"color\": \"#2563eb\",\n    \"status\": \"public\"\n  }\n}\n",[66,527,528,532,538,548,558,568,578,588,598,606,611],{"__ignoreMap":109},[113,529,530],{"class":115,"line":116},[113,531,142],{"class":141},[113,533,534,536],{"class":115,"line":122},[113,535,148],{"class":147},[113,537,151],{"class":141},[113,539,540,542,544,546],{"class":115,"line":154},[113,541,157],{"class":147},[113,543,160],{"class":141},[113,545,163],{"class":147},[113,547,166],{"class":141},[113,549,550,552,554,556],{"class":115,"line":169},[113,551,172],{"class":147},[113,553,160],{"class":141},[113,555,177],{"class":147},[113,557,166],{"class":141},[113,559,560,562,564,566],{"class":115,"line":182},[113,561,185],{"class":147},[113,563,160],{"class":141},[113,565,191],{"class":190},[113,567,166],{"class":141},[113,569,570,572,574,576],{"class":115,"line":196},[113,571,199],{"class":147},[113,573,160],{"class":141},[113,575,204],{"class":190},[113,577,166],{"class":141},[113,579,580,582,584,586],{"class":115,"line":209},[113,581,212],{"class":147},[113,583,160],{"class":141},[113,585,217],{"class":190},[113,587,166],{"class":141},[113,589,590,592,594,596],{"class":115,"line":222},[113,591,225],{"class":147},[113,593,160],{"class":141},[113,595,230],{"class":190},[113,597,166],{"class":141},[113,599,600,602,604],{"class":115,"line":235},[113,601,238],{"class":147},[113,603,160],{"class":141},[113,605,243],{"class":190},[113,607,608],{"class":115,"line":246},[113,609,610],{"class":141},"  }\n",[113,612,613],{"class":115,"line":252},[113,614,266],{"class":141},[79,616,270],{"id":617},"example-response-error-1",[104,619,621],{"className":132,"code":620,"language":134,"meta":109,"style":109},"{\n  \"error\": \"User ID, name, style and status are required\"\n}\n",[66,622,623,627,636],{"__ignoreMap":109},[113,624,625],{"class":115,"line":116},[113,626,142],{"class":141},[113,628,629,631,633],{"class":115,"line":122},[113,630,284],{"class":147},[113,632,160],{"class":141},[113,634,635],{"class":190},"\"User ID, name, style and status are required\"\n",[113,637,638],{"class":115,"line":154},[113,639,266],{"class":141},[71,641,643],{"id":642},"delete-method","DELETE Method",[62,645,646],{},"Deletes a specific board.",[79,648,82],{"id":649},"parameters-2",[84,651,652,657],{},[87,653,654,656],{},[66,655,91],{}," (required): The ID of the board to delete.",[87,658,659,661],{},[66,660,97],{}," (required): The ID of the user deleting the board.",[79,663,102],{"id":664},"example-request-1",[104,666,668],{"className":106,"code":667,"language":108,"meta":109,"style":109},"DELETE \u002Fapi\u002Fdata\u002Fboard?id=123&userId=456\nX-API-Key: your_api_key_here\n",[66,669,670,675],{"__ignoreMap":109},[113,671,672],{"class":115,"line":116},[113,673,674],{},"DELETE \u002Fapi\u002Fdata\u002Fboard?id=123&userId=456\n",[113,676,677],{"class":115,"line":122},[113,678,125],{},[79,680,129],{"id":681},"example-response-success-2",[104,683,685],{"className":132,"code":684,"language":134,"meta":109,"style":109},"{\n  \"message\": \"Board deleted successfully\"\n}\n",[66,686,687,691,701],{"__ignoreMap":109},[113,688,689],{"class":115,"line":116},[113,690,142],{"class":141},[113,692,693,696,698],{"class":115,"line":122},[113,694,695],{"class":147},"  \"message\"",[113,697,160],{"class":141},[113,699,700],{"class":190},"\"Board deleted successfully\"\n",[113,702,703],{"class":115,"line":154},[113,704,266],{"class":141},[79,706,270],{"id":707},"example-response-error-2",[104,709,710],{"className":132,"code":273,"language":134,"meta":109,"style":109},[66,711,712,716,724],{"__ignoreMap":109},[113,713,714],{"class":115,"line":116},[113,715,142],{"class":141},[113,717,718,720,722],{"class":115,"line":122},[113,719,284],{"class":147},[113,721,160],{"class":141},[113,723,289],{"class":190},[113,725,726],{"class":115,"line":154},[113,727,266],{"class":141},[71,729,731],{"id":730},"patch-method","PATCH Method",[62,733,734],{},"Updates the order of areas within a board.",[79,736,82],{"id":737},"parameters-3",[84,739,740,746],{},[87,741,742,745],{},[66,743,744],{},"boardId"," (required): The ID of the board for which the area order is to be updated.",[87,747,748,751],{},[66,749,750],{},"areas"," (required): An array of area objects with their new sort order.",[79,753,102],{"id":754},"example-request-2",[104,756,758],{"className":132,"code":757,"language":134,"meta":109,"style":109},"PATCH \u002Fapi\u002Fdata\u002Fboard\nContent-Type: application\u002Fjson\nX-API-Key: your_api_key_here\n\n{\n  \"boardId\": 123,\n  \"areas\": [\n    {\n      \"id\": 456,\n      \"sort\": 1\n    },\n    {\n      \"id\": 789,\n      \"sort\": 2\n    }\n  ]\n}\n",[66,759,760,765,769,773,777,781,792,800,805,816,826,831,835,847,857,863,869],{"__ignoreMap":109},[113,761,762],{"class":115,"line":116},[113,763,764],{"class":141},"PATCH \u002Fapi\u002Fdata\u002Fboard\n",[113,766,767],{"class":115,"line":122},[113,768,372],{"class":141},[113,770,771],{"class":115,"line":154},[113,772,125],{"class":141},[113,774,775],{"class":115,"line":169},[113,776,382],{"emptyLinePlaceholder":381},[113,778,779],{"class":115,"line":182},[113,780,142],{"class":141},[113,782,783,786,788,790],{"class":115,"line":196},[113,784,785],{"class":147},"  \"boardId\"",[113,787,160],{"class":141},[113,789,163],{"class":147},[113,791,166],{"class":141},[113,793,794,797],{"class":115,"line":209},[113,795,796],{"class":147},"  \"areas\"",[113,798,799],{"class":141},": [\n",[113,801,802],{"class":115,"line":222},[113,803,804],{"class":141},"    {\n",[113,806,807,810,812,814],{"class":115,"line":235},[113,808,809],{"class":147},"      \"id\"",[113,811,160],{"class":141},[113,813,177],{"class":147},[113,815,166],{"class":141},[113,817,818,821,823],{"class":115,"line":246},[113,819,820],{"class":147},"      \"sort\"",[113,822,160],{"class":141},[113,824,825],{"class":147},"1\n",[113,827,828],{"class":115,"line":252},[113,829,830],{"class":141},"    },\n",[113,832,833],{"class":115,"line":263},[113,834,804],{"class":141},[113,836,838,840,842,845],{"class":115,"line":837},13,[113,839,809],{"class":147},[113,841,160],{"class":141},[113,843,844],{"class":147},"789",[113,846,166],{"class":141},[113,848,850,852,854],{"class":115,"line":849},14,[113,851,820],{"class":147},[113,853,160],{"class":141},[113,855,856],{"class":147},"2\n",[113,858,860],{"class":115,"line":859},15,[113,861,862],{"class":141},"    }\n",[113,864,866],{"class":115,"line":865},16,[113,867,868],{"class":141},"  ]\n",[113,870,872],{"class":115,"line":871},17,[113,873,266],{"class":141},[79,875,129],{"id":876},"example-response-success-3",[104,878,880],{"className":132,"code":879,"language":134,"meta":109,"style":109},"{\n  \"message\": \"Area order updated successfully\"\n}\n",[66,881,882,886,895],{"__ignoreMap":109},[113,883,884],{"class":115,"line":116},[113,885,142],{"class":141},[113,887,888,890,892],{"class":115,"line":122},[113,889,695],{"class":147},[113,891,160],{"class":141},[113,893,894],{"class":190},"\"Area order updated successfully\"\n",[113,896,897],{"class":115,"line":154},[113,898,266],{"class":141},[79,900,270],{"id":901},"example-response-error-3",[104,903,905],{"className":132,"code":904,"language":134,"meta":109,"style":109},"{\n  \"error\": \"Board ID and areas array are required for PATCH requests\"\n}\n",[66,906,907,911,920],{"__ignoreMap":109},[113,908,909],{"class":115,"line":116},[113,910,142],{"class":141},[113,912,913,915,917],{"class":115,"line":122},[113,914,284],{"class":147},[113,916,160],{"class":141},[113,918,919],{"class":190},"\"Board ID and areas array are required for PATCH requests\"\n",[113,921,922],{"class":115,"line":154},[113,923,266],{"class":141},[71,925,927],{"id":926},"authentication","Authentication",[62,929,930,931,934],{},"The endpoint requires authentication via an API key or session. Unauthorized requests will receive a ",[66,932,933],{},"403 Forbidden"," error.",[71,936,938],{"id":937},"error-handling","Error Handling",[84,940,941,947,952,958,964],{},[87,942,943,946],{},[66,944,945],{},"400 Bad Request",": Missing required parameters.",[87,948,949,951],{},[66,950,933],{},": Unauthorized access.",[87,953,954,957],{},[66,955,956],{},"404 Not Found",": Board not found.",[87,959,960,963],{},[66,961,962],{},"405 Method Not Allowed",": Unsupported HTTP method.",[87,965,966,969],{},[66,967,968],{},"500 Internal Server Error",": Database or server error.",[326,971,972],{},"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":122,"depth":122,"links":974},[975,981,988,994,1000,1001],{"id":73,"depth":122,"text":74,"children":976},[977,978,979,980],{"id":81,"depth":154,"text":82},{"id":101,"depth":154,"text":102},{"id":128,"depth":154,"text":129},{"id":269,"depth":154,"text":270},{"id":296,"depth":122,"text":297,"children":982},[983,984,985,986,987],{"id":303,"depth":154,"text":82},{"id":356,"depth":154,"text":357},{"id":437,"depth":154,"text":438},{"id":522,"depth":154,"text":129},{"id":617,"depth":154,"text":270},{"id":642,"depth":122,"text":643,"children":989},[990,991,992,993],{"id":649,"depth":154,"text":82},{"id":664,"depth":154,"text":102},{"id":681,"depth":154,"text":129},{"id":707,"depth":154,"text":270},{"id":730,"depth":122,"text":731,"children":995},[996,997,998,999],{"id":737,"depth":154,"text":82},{"id":754,"depth":154,"text":102},{"id":876,"depth":154,"text":129},{"id":901,"depth":154,"text":270},{"id":926,"depth":122,"text":927},{"id":937,"depth":122,"text":938},"The api\u002Fdata\u002Fboard endpoint is used to manage boards. It supports retrieving, creating, updating, and deleting boards, as well as updating the order of areas within a board.","md",{},{"title":21,"description":1002},"lqkbdnG8inqfOWKy53-Gq8brrgnNmaX3dX6xOg5Y79M",1786546244239]