Search for objects

Searches for objects using a powerful query language.


  • tenant_id – The ID of the tenant.
  • working_copy_id – The ID of the working copy to search in.

Params as part of the payload

  • boost – The list of boost queries.
  • continuation – A continuation handle as returned by a previous search request.
  • facets – A list of facet requests.
  • include_objs – Specifies whether to include the objects in the result or to return only their IDs.
  • options – A map of additional options. The supported keys are include_deleted, include_editing_assets, and site_aware. To query any other site than the default one (with multi-site tenants), set site_aware to true and specify the _site_id in your query.
  • order_by – A list of sort criteria to be applied to the search result.
  • query – The list of search queries. Each element restricts the result using “and”. To negate an additional query, specify the negate: true parameter. The field value may be * which acts as a wildcard for having all attributes searched.
  • size – The maximum number of hits to return.

Example of the boost parameter:

Example of the facets parameter:

Example of the options parameter:

Example of the order_by parameter:

Example of the query parameter:


A map containing the following keys:

  • continuation – A continuation handle; present if not all hits were returned. In this case, add the continuation key and value to the subsequent request to fetch the next batch.
  • facets – A list of facet results; present if facets were requested.
  • objs – A list of found objects; present if include_objs was set.
  • results – A list of maps containing the IDs of the objects found.
  • total – The total number of objects found.

The results are restricted to the visibility categories applicable to the user.


Find CMS objects whose title or description attribute value starts with term:

Same as above, but only find CMS objects not in the /products path (whose _path attribute value does not start with /products):

Error codes

  • validation.illegal_value
  • validation.invalid_value


  • The GET method is supported as well.
  • The result never includes more than 100 hits, even if size is set to a larger value.
  • The number of facet queries is limited to 10.
  • The number of returned objects may be less than the number of returned object IDs if the tenant’s rate limit was reached.