Sign in
Search

Retrieve assets by city

Changed on

Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.

get/search/cities

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/search/cities
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Response

checksumstring required

Base64 encoded SHA1 hash

createdAtstring date-time required

The UTC timestamp when the asset was originally uploaded to Immich.

duplicateIdstring uuid nullable

Duplicate group ID

durationinteger nullable required

Video/gif duration in milliseconds (null for static images)

fileCreatedAtstring date-time required

The actual UTC timestamp when the file was created/captured, preserving timezone information. This is the authoritative timestamp for chronological sorting within timeline groups. Combined with timezone data, this can be used to determine the exact moment the photo was taken.

fileModifiedAtstring date-time required

The UTC timestamp when the file was last modified on the filesystem. This reflects the last time the physical file was changed, which may be different from when the photo was originally taken.

hasMetadataboolean required

Whether asset has metadata

heightinteger nullable required

Asset height

idstring uuid required

Asset ID

isArchivedboolean required

Is archived

isEditedboolean required

Is edited

isFavoriteboolean required

Is favorite

isOfflineboolean required

Is offline

isTrashedboolean required

Is trashed

libraryIdstring uuid nullable

Library ID

livePhotoVideoIdstring nullable

Live photo video ID

localDateTimestring date-time required

The local date and time when the photo/video was taken, derived from EXIF metadata. This represents the photographer's local time regardless of timezone, stored as a timezone-agnostic timestamp. Used for timeline grouping by "local" days and months.

originalFileNamestring required

Original file name

originalMimeTypestring

Original MIME type

originalPathstring required

Original file path

ownerIdstring uuid required

Owner user ID

resizedboolean

Is resized

thumbhashstring nullable required

Thumbhash for thumbnail generation (base64) also used as the c query param for thumbnail cache busting.

type'IMAGE' | 'VIDEO' | 'AUDIO' | 'OTHER' required

Asset type

updatedAtstring date-time required

The UTC timestamp when the asset record was last updated in the database. This is automatically maintained by the database and reflects when any field in the asset was last modified.

visibility'archive' | 'timeline' | 'hidden' | 'locked' required

Asset visibility

widthinteger nullable required

Asset width

Changes

  • 2cd7bd44a940Revision changes
    • info

      the / response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the / response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the / response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the /// response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the ////// response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the ////// response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the /// response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

  • 2d1bbbdaa362Revision changes
    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property / from the response with the status