Homarr
Apps

Search apps

GET/api/apps/search

Find apps whose names contain the query, ordered by name. Requires app-modify-all or board-modify-all permission; returns up to 100 results.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Query Parameters

query*string
limit?number
Range1 <= value <= 100
Default10

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/apps/search?query=string"
[  {    "id": "string",    "name": "string",    "description": "string",    "iconUrl": "string",    "href": "string",    "pingUrl": "string"  }]

Create an app

Create an app bookmark. Requires app-create permission. Returns the app, including its ID and the legacy appId field. An empty pingUrl disables the custom ping URL.

List selectable apps

Return app IDs, names, icons, descriptions, destination URLs, and ping URLs for selection controls. Requires authentication.