Skip to content

Favorites API

Endpoints for managing favorite items.

List Favorites

Get all favorited items.

GET /api/favorites

Response

[
    {
        "id": 5,
        "path": "photos/vacation/beach.jpg",
        "name": "beach.jpg",
        "type": "image",
        "parentPath": "photos/vacation",
        "createdAt": "2026-04-03T18:25:19Z"
    },
    {
        "path": "videos/highlights",
        "name": "highlights",
        "type": "folder"
    }
]

Add Favorite

Add an item to favorites.

POST /api/favorites

Request

{
    "path": "photos/vacation/beach.jpg",
    "name": "beach.jpg",
    "type": "image"
}

Response

{
    "status": "ok"
}

Remove Favorite

Remove an item from favorites.

DELETE /api/favorites

Request

{
    "path": "photos/vacation/beach.jpg"
}

Response

{
    "status": "ok"
}

Bulk Add Favorites

Add multiple items to favorites at once.

POST /api/favorites/bulk

Request

{
    "items": [
        {
            "path": "photos/vacation/beach.jpg",
            "name": "beach.jpg",
            "type": "image"
        },
        {
            "path": "photos/vacation/sunset.jpg",
            "name": "sunset.jpg",
            "type": "image"
        }
    ]
}

Response

{
    "success": 2,
    "failed": 0,
    "errors": []
}

Notes

  • Up to 100 items are processed per request.
  • Empty paths are ignored.
  • Error lists are truncated to avoid oversized responses.

Bulk Remove Favorites

Remove multiple favorites at once.

DELETE /api/favorites/bulk

Request

{
    "paths": [
        "photos/vacation/beach.jpg",
        "photos/vacation/sunset.jpg"
    ]
}

Response

{
    "success": 2,
    "failed": 0,
    "errors": []
}

Reorder Favorites

Replace the display order of the favorites strip.

PUT /api/favorites/order

Request

{
    "paths": [
        "photos/vacation/sunset.jpg",
        "photos/vacation/beach.jpg"
    ]
}

Response

{
    "status": "ok"
}

For exact request and response schemas, see the OpenAPI specification.