Get Images by query

get

https://developers.bloomreach.io/delivery/site/v2/images/

Return the images which match the search / filter and a result set object containing info like total hits, limit and offset

Query Params

namespace

string

Filters for all images of a specific namespace. At this moment images are always in the 'xm' or 'hippogallery' namespace

contentType

string

Filters for all images of a specific contentType. At this moment images always have contentType 'image'

uuid

Filters for all images with a specific UUID. Comma separated values are allowed which are processed as an OR constraint

path

string

Filters for all images with a specific path. Comma separated values are allowed which are processed as an OR constraint

mimeType

string

Filters for all images of a specific mimeType.

height

integer

Filters for all images with a specific height

height(lt)

integer

Filters for all images smaller than a specific height. If the height itself should be included, use height(lte). For larger images use height(gt) and height(lte)

width

integer

Filters for all images with a specific width

width(lt)

integer

Filters for all images smaller than a specific width. If the width itself should be included, use width(lte). For larger images use width(gt) and width(lte)

string

Does a free text search for images containing the text provided by the parameter. The value will be parsed in case it contains special characters like * or ?. This can be found in online documentation

lastModified

integer

A query for all images having a last modification date of the provided value

lastModified(lt)

integer

A query for all images having a last modification date before the provided value. When the provided value should be included, use lastModified(lte). For greater than, use lastModified(gt) or lastModified(gte)

offset

integer

≥ 0

Defaults to 0

The number of images to skip before starting to collect the 'images' array field.

limit

integer

1 to 100

Defaults to 10

The maximum number of images to return in the 'images' array field.

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200An array of images complying to the search criteria

400Invalid Query