Sign in
Search

Retrieve search suggestions

Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.

get/search/suggestions

Request

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

Query parameters

countrystring

Filter by country

includeNullboolean

Include null values in suggestions

lensModelstring

Filter by lens model

makestring

Filter by camera make

modelstring

Filter by camera model

statestring

Filter by state/province

type'country' | 'state' | 'city' | 'camera-make' | 'camera-model' | 'camera-lens-model' required

Suggestion type

Response

string[] required

Changes

No recorded changes to this operation across all 50 revisions of this API.