Search for entities in Confluence using the Confluence Query Language (CQL). For example:
Example request URI(s):
http://localhost:8080/confluence/rest/api/search?cql=creator=currentUser()&type%20in%20(space,page,user)&cqlcontext={"spaceKey":"TST", "contentId":"55"}
http://localhost:8080/confluence/rest/api/search?cql=siteSearch~'example'%20AND%20label=docs&expand=content.space,space.homepage&limit=10
string
string
string
string
string
string
string
string
returns a full JSON representation of a list of search results.
1
2
3
4
5
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/search' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '"<string>"'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
"results": [
{
"title": "Page Title",
"excerpt": "This is an excerpt of the page content",
"url": "http://localhost:8080/confluence/display/SPACEKEY/Page+Title",
"resultParentContainer": {
"title": "Demo Title",
"displayUrl": "http://localhost:8080/confluence/display/SPACEKEY/Page+Title"
},
"resultGlobalContainer": {
"title": "Demo Title",
"displayUrl": "http://localhost:8080/confluence/display/SPACEKEY/Page+Title"
},
"iconCssClass": "<string>",
"lastModified": "<string>",
"friendlyLastModified": "<string>",
"resultGlobalContainerRef": {
"idProperties": {},
"expanded": true
},
"entityRef": {
"idProperties": {},
"expanded": true
},
"resultParentRef": {
"idProperties": {},
"expanded": true
},
"resourceType": {
"name": "<string>",
"type": "<string>",
"url": "<string>"
},
"entity": {},
"entityType": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"totalCount": 2154,
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Rate this page: