.. include:: /includes.rst.txt

.. comments - headings

   # with overline, for parts
   * with overline, for chapters
   = for sections
   - for subsections
   ^ for subsubsections
   " for paragraphs



.. index:: pair: Searching; API

.. _search_results_via_api_target:

Search results via API
----------------------

Search results and facets can be accessed via an API.
The results are returned as JSON.

Service Syntax
^^^^^^^^^^^^^^

http://…/search/results

http://…/search/facets

Arguments
^^^^^^^^^

.. list-table::

   * - term
     - search term or phrase (uses query syntax)
     - optional
   * - limit
     - number of results returned
     - optional
   * - offset
     - number for offset
     - optional
   * - withFacets
     - true or false
     - optional