searchQuery
parameter can be used to apply advanced filters to your search.AND
and OR
operators. For example:file-name
.(
and )
to group multiple queries and create complex search filters. For example:red-dress-summer.jpg
and red-dress-winter.jpg
in the media library.=
operator. For example:red-dress-summer.jpg
.:
operator. For example:red-dress-summer.jpg
and red-dress-winter.jpg
.createdAt
and updatedAt
to search based on the first uploaded or last modified time.createdAt
and updatedAt
accept ISO 8601 format string or relative unit.YYYY-MM-DD
- When no time is provided, it is set to 00:00:00 UTC by default.YYYY-MM-DDTHH:MM:SS
1h
- one hour in the past2d
- two days in the past3w
, 4m
, etc."embeddedMetadata.Keywords" IN ["black"]
"customMetadata.description" IN ["black"]
name = "red-dress.jpg"
will return all
files & folders with the exact name red-dress.jpg
.name: "red-dress"
will return all files & foldersred-dress
.name IN ["red-dress.jpg", "red-dress.png"]
will returnred-dress.jpg
orred-dress.png
.name NOT = "red-dress.jpg"
will return all files and foldersred-dress.jpg
.tags IN ["summer-collection", "sale"]
will return all files that have either summer-collection
or sale
inside either the tags array or the AITags array.tags NOT IN ["big-banner"]
will return all files that do not have big-banner
inside neither the tags array nor the AITags array.file
, file-version
or folder
in quotes or in the array.type = "file"
will only return files in the search result.
type = "file-version"
will only return file versions in the search result.
type = "folder"
will only return folders in the search result.
type IN ["file", "folder"]
will return both files and folders in the search result.1h
, 2d
, 3w
, or 4m
.
createdAt > "2020-01-01"
will return all files first uploaded
after 1 Jan 2020 at 00:00 hours in UTC.createdAt > "2020-01-01T12:12:12"
will return all files first uploaded after 1 Jan 2020 12:12:12 hours in UTC.createdAt > "7d"
will return all files first uploaded in the last 7 days.1h
, 2d
, 3w
, or 4m
.
updatedAt > "2020-01-01"
will return all files last modified
after 1 Jan 2020 at 00:00 hours in UTC.updatedAt > "2020-01-01T12:12:12"
will return all files last modified after 1 Jan 2020 12:12:12 hours in UTC.updatedAt > "7d"
will return all files last modified in the last 7 days.500
, 200
etc. This is only applicable for image-type assets.height > 200
will return all image files with a height greater than 200px.height <= 400
will return all image files with a height less than or equal to 400px.500
, 200
etc. This is only applicable for image-type assets.width > 200
will return all image files with a width greater than 200px.width <= 400
will return all image files with a width less than or equal to 400px.500
, 200
or string e.g. 1mb
, 10kb
etc.size > 1024
will return all assets with a file size greater than 1024 bytes.
size <= "1mb"
will return all assets with a file size less than or equal to 1MB.jpg
, webp
, png
, gif
, svg
, avif
, pdf
, js
, woff2
, woff
, ttf
, otf
, eot
, css
, txt
, mp4
, webm
, mov
, swf
, ts
, m3u8
, ico
.format = "jpg"
will return all JPG image files.true
or false
without quotes.private = true
will return all files marked as private during upload.true
or false
without quotes. This is only applicable to images.transparency = true
will return all image files that have an alpha layer. However, the presence of the alpha layer does not guarantee transparency if all pixels in the alpha layer have the value 1.latitude,longitude
"embeddedMetadata.Keywords" IN ["luxury", "dress"]
will return all files that have either luxury
or dress
as one of the values in its Keywords field."embeddedMetadata.Keywords" NOT IN ["big-banner"]
will return all files that do not have big-banner
as one of the values in its Keywords field.1h
, 2d
, 3w
, or 4m
.
"embeddedMetadata.DateTimeOriginal" > "2020-01-01"
will return all files with a value later than 1 Jan 2020 at 00:00 hours in UTC."embeddedMetadata.DateTimeOriginal" > "2020-01-01T12:12:12"
will return all files with a value later than 1 Jan 2020 12:12:12 hours in UTC."embeddedMetadata.DateTimeOriginal" > "7d"
will return all files with a value that lies in the last 7 days.Text
type field"customMetadata.description" = "black cars"
will return all files & folders with the description custom field exactly equal to black cars
."customMetadata.description": "red"
will return all files & folders with the description custom field starting with red
."customMetadata.description" IN ["red cars", "black cars"]
will return all files & folders with the description custom field either red cars
orblack cars
."customMetadata.description" NOT = "red dress"
will return all files and foldersred dress
.Textarea
type field"customMetadata.longDescription": "luxury"
will return all files & folders with the longDescription custom field starting with luxury
.Date
type field1h
, 2d
, 3w
, or 4m
.
"customMetadata.purchaseDate" > "2020-01-01"
will return all files with a purchaseDate value later than 1 Jan 2020 at 00:00 hours in UTC."customMetadata.purchaseDate" > "2020-01-01T12:12:12"
will return all files with a purchaseDate value later than 1 Jan 2020 12:12:12 hours in UTC."customMetadata.purchaseDate" > "7d"
will return all files with a purchaseDate value that lies in the last 7 days.Number
type field500
, 200.125
, etc."customMetadata.quantitySold" > 200
will return all items with a quantitySold value greater than 200."customMetadata.quantitySold" <= 400
will return all items with a quantitySold value less than or equal to 400.Boolean
type fieldtrue
or false
without quotes."customMetadata.active" = true
will return all items with an active value equal to true.SingleSelect
type "customMetadata.rating" = "excellent"
will return all files with a rating value equal to excellent
"customMetadata.rating" > 4.3
will return all files that have a numeric rating value that is greater than 4.3200
status code with the list of file object in the JSON-encoded response body on success.sort
option.searchQuery
parameter.createdAt >= "7d" AND size > "2mb"
clothing
or accessories
categories using a custom metadata field called category
. The custom metadata schema for this field must have been defined first."customMetadata.category IN ["clothing", "accessories"]"
DateTimeOriginal
value later than one year ago by using the embeddedMetadata.DateTimeOriginal
field. i.e. all files that were originally created within the last one year."embeddedMetadata.DateTimeOriginal" > "1y"
file-name.jpg
. We will use the following value of thesearchQuery
parameter. The match is always case-sensitive.name="file-name.jpg"
sale
or summer
tag.PNG
type files. We will use the following value of searchQuery
format="png"