list_photos
Search and list photos and videos in Synology Photos by folder, person, tag, date, type, rating, or favorite, with album, place, concept, and keyword filters. Returns IDs for details or download.
Instructions
List or search photos and videos in Synology Photos, newest first by default, with the total. folder, person and tag combine with the date, type, rating and favorite filters; album, place, concept and keyword each work alone. Each row has the item's id, filename, taken time, type, size and folder; pass the ids to get_photo for full details or to download_photos to save the files. For files outside Photos, use File Station's list_files when that module is enabled.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Only items with this tag name. | |
| type | No | `all` (default), `photo` or `video`. | all |
| album | No | One album only (personal space). Album ID (list_photo_collections type=album) or unique name. | |
| limit | No | Most items to return, 1-500. | |
| place | No | One place only: a place ID from list_photo_collections type=place. | |
| space | No | `personal` (default) or `shared` (Shared Space). IDs belong to one space. | personal |
| folder | No | Only items directly in this folder, not subfolders. Folder ID (list_photo_collections type=folder) or path, such as `/Trips/2024`. | |
| offset | No | Entries to skip, for the next page. | |
| person | No | Only items showing this person. Person ID (list_photo_collections type=person) or unique name. | |
| concept | No | One concept only (a thing or scene Photos recognized): an ID from list_photo_collections type=concept. Photos 1.9.1+. | |
| keyword | No | Search filenames and tag names; works alone, in search order (no sorting). | |
| sort_by | No | `taken` (default), `filename`, `size` or `type`. | taken |
| end_date | No | Taken on or before this date, `YYYY-MM-DD`. | |
| favorite | No | `true`: favorites only (Photos 1.9.1+). `false` doesn't filter. | |
| min_rating | No | Minimum rating, 1-5. | |
| start_date | No | Taken on or after this date, `YYYY-MM-DD` (the photo's local time). | |
| sort_direction | No | `desc` (default) or `asc`. | desc |