/
REST API, common errors and examples:

REST API, common errors and examples:

Owned by Lorenzo Manfredini
Last updated: Apr 11, 2025 by Enrico Kutscher

The documentation for the Metadata ReST API is available here: https://communardo-products.atlassian.net/wiki/x/QAF8

When constructing the url, ensure that you include all required Path and Query parameters as described.

To send a request to the ReST endpoint you must provide at least the following mandatory url parameters:

  • cql - the search query. For example, metadataset="global.metadataset.exampleset" to find all pages associated with the global set identified by the key “global.metadataset.exampleset.”

  • sort - for instance, content-name-untokenized to sort results by page title.

  • sortdirection - specify either ASCENDING or DESCENDING.

  • pagesize - for example, 10 to retrieve 10 results per page.

In this context, the parameter names are presented in bold, while example values are shown in italic.

In the CQL section of your query, you can filter using any valid CQL expression. This encompasses not only metadata fields or sets but also Confluence Search Fields.

Related Articles