Homarr
Boards

List accessible boards

GET/api/boards

Return accessible boards with creator details, visibility, and the current user's desktop and mobile home flags. Anonymous callers can see public boards.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/boards"
[  {    "id": "string",    "name": "string",    "logoImageUrl": "string",    "isPublic": true,    "creator": {      "id": "string",      "name": "string",      "image": "string",      "email": "string"    },    "isHome": true,    "isMobileHome": true,    "userPermissions": [      {        "permission": "view"      }    ],    "groupPermissions": [      {        "permission": "view"      }    ]  }]

Delete an app

Delete an app by ID and invalidate linked integration caches. Requires app-full-all permission.

Create a board

Create a board with base and mobile layouts. Requires board-create permission. Returns the board ID, name, and base layout ID; sets the creator's home board if none is selected.