Skip to content

manage_search

Unified tool for searching Confluence with CQL or quick text search.

ParameterTypeRequiredDescription
actionstringYescql or quick
cqlstringFor cqlCQL query string
querystringFor quickText to search for
limitintNoNumber of results (default 25)
startintNoStarting offset for pagination
include_archived_spacesboolNoInclude archived spaces

Search using Confluence Query Language. This uses the V1 REST API (the V2 API does not expose CQL search).

Required: cql

{
"action": "cql",
"cql": "type=page AND space=DEV AND title~'architecture'",
"limit": 10
}

Response:

{
"results": [
{
"title": "Architecture Overview",
"excerpt": "System architecture and design principles...",
"type": "page",
"content_id": "12345678",
"space_key": "DEV",
"url": "/wiki/spaces/DEV/pages/12345678"
}
],
"total_size": 1,
"start": 0,
"limit": 10
}

Quick text search across titles and content.

Required: query

{
"action": "quick",
"query": "migration guide",
"limit": 5
}

Response:

{
"results": [
{
"title": "Database Migration Guide",
"excerpt": "Step-by-step guide for database migrations...",
"type": "page",
"content_id": "12345679",
"space_key": "DEV"
}
],
"total_size": 1
}