u

docs/api/routes/brand/list.md

@@ -4,7 +4,7 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
 
 List brands
 
-Lists brands for the authenticated user's selected company, sorted by name. Paged; `total` is the unpaged count.
+Lists brands for the authenticated user's selected company, sorted by name. Paged; `total` is the unpaged count. Small-thumbnail fields are omitted by default. Set `includeSmallThumbs=true` to include each picture's `smallThumbW`, `smallThumbH`, and `smallThumbBinary` (base64-encoded AVIF bytes, resized with a 40px maximum edge).
 
 ## Query parameters
 
@@ -12,6 +12,7 @@ Lists brands for the authenticated user's selected company, sorted by name. Page
 |-------|----------|------|-------------|
 | `offset` | no | integer | Number of brands to skip |
 | `limit` | no | integer | Number of brands to return |
+| `includeSmallThumbs` | no | boolean | Include each picture's small thumbnail dimensions and base64 AVIF bytes. |
 
 ## Response `200`
 
@@ -29,7 +30,10 @@ Brand list
           "fullHash": "…",
           "thumbW": 1,
           "thumbH": 1,
-          "thumbHash": "…"
+          "thumbHash": "…",
+          "smallThumbW": 1,
+          "smallThumbH": 1,
+          "smallThumbBinary": "…"
         }
       ]
     }
@@ -44,7 +48,7 @@ Brand list
 
 | Status | Description |
 |--------|-------------|
-| 400 | Invalid offset, invalid limit, or no company selected — `{"error":"…"}` |
+| 400 | Invalid offset, invalid limit, invalid includeSmallThumbs, or no company selected — `{"error":"…"}` |
 | 401 | Unauthorized — `{"error":"…"}` |
 | 403 | Not authorized — `{"error":"…"}` |
 | 404 | Company not found — `{"error":"…"}` |