OpenAPI

Homarr API reference

Browse request parameters and response schemas, enter your Homarr instance’s full URL in Server URL, then review examples or send a test request from your browser.

List apps with pagination List all apps Create an app Search apps List selectable apps Get an app Update an app Delete an app List accessible boards Create a board Duplicate a board Rename a board Change board visibility Delete a board Set your desktop home board Set your mobile home board Update board settings Add an item to a board Get server information List user invitations Create a user invitation Delete a user invitation Get global board settings Update global board settings List all users Create a user Set a profile image List selectable users Search users Get a user Delete a user Update a user profile Change a user password Change user home boards Change the default search engine Update search preferences Change your color scheme Change widget context menu behavior Update header preferences Change DuckDuckGo bang behavior Change the first day of the week Proxy an integration API request using saved credentials