Get documents by query

get

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

namespace

string

Filters for all documents of a specific namespace. It is strongly adviced to always include this query parameter as skipping it can result in unexpected result in case there are for example also test namespaces

contentType

string

Filters for all documents of a specific contentType. Best to use in combination with the namespace parameter

uuid

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

path

string

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

string

Does a free text search for documents 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

q(title)

string

This is an example free text search in a document its title field. You can substitute 'title' for any actual real used fields in your document types

locale

string

Filters (case insenstive) for all documents with a certain locale

lastModified

integer

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

folder

string

A query to search for documents in a specific folder. This is a relative folder path to restrict the document search.

lastModified(lt)

integer

A query for all documents 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 documents to skip before starting to collect the 'documents' array field.

limit

integer

1 to 100

Defaults to 10

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

Responses

200A document for the provided id

400Invalid Query