Returns the list of content that matches a Confluence Query Language (CQL) query. For information on CQL, see: Advanced searching using CQL. Permissions required: Permission to access the Confluence site (‘Can use’ global permission). Only content that the user has permission to view will be returned.

External Documentation

To learn more, visit the Confluence documentation.

​
Basic Parameters

ParameterDescription
CQLThe CQL string that is used to find the requested content.

​
Advanced Parameters

ParameterDescription
LimitThe maximum number of content objects to return per page. Note: this may be restricted by fixed system limits.

​
Example Output

{
	"results": [
		{
			"id": "<string>",
			"type": "<string>",
			"status": "<string>",
			"title": "<string>",
			"space": {
				"id": 2154,
				"key": "<string>",
				"name": "<string>",
				"icon": {
					"path": "<string>",
					"width": 2154,
					"height": 2154,
					"isDefault": true
				},
				"description": {
					"plain": {
						"value": "<string>",
						"representation": "plain",
						"embeddedContent": [
							{}
						]
					},
					"view": {
						"value": "<string>",
						"representation": "plain",
						"embeddedContent": [
							{}
						]
					},
					"_expandable": {
						"view": "<string>",
						"plain": "<string>"
					}
				},
				"type": "<string>",
				"metadata": {
					"labels": {
						"results": [
							{
								"prefix": "<string>",
								"name": "<string>",
								"id": "<string>",
								"label": "<string>"
							}
						],
						"size": 2154
					},
					"_expandable": {}
				},
				"operations": [
					{
						"operation": "administer",
						"targetType": "<string>"
					}
				],
				"permissions": [
					{
						"operation": {
							"operation": "administer",
							"targetType": "<string>"
						},
						"anonymousAccess": true,
						"unlicensedAccess": true
					}
				],
				"status": "<string>",
				"settings": {
					"routeOverrideEnabled": true,
					"_links": {}
				},
				"theme": {
					"themeKey": "<string>"
				},
				"lookAndFeel": {
					"headings": {
						"color": "<string>"
					},
					"links": {
						"color": "<string>"
					},
					"menus": {
						"hoverOrFocus": {
							"backgroundColor": "<string>"
						},
						"color": "<string>"
					},
					"header": {
						"backgroundColor": "<string>",
						"button": {
							"backgroundColor": "<string>",
							"color": "<string>"
						},
						"primaryNavigation": {
							"color": "<string>",
							"hoverOrFocus": {
								"backgroundColor": "<string>",
								"color": "<string>"
							}
						},
						"secondaryNavigation": {
							"color": "<string>",
							"hoverOrFocus": {
								"backgroundColor": "<string>",
								"color": "<string>"
							}
						},
						"search": {
							"backgroundColor": "<string>",
							"color": "<string>"
						}
					},
					"content": {},
					"bordersAndDividers": {
						"color": "<string>"
					}
				},
				"history": {
					"createdDate": "<string>",
					"createdBy": {
						"type": "known"
					}
				},
				"_expandable": {
					"settings": "<string>",
					"metadata": "<string>",
					"operations": "<string>",
					"lookAndFeel": "<string>",
					"permissions": "<string>",
					"icon": "<string>",
					"description": "<string>",
					"theme": "<string>",
					"history": "<string>",
					"homepage": "<string>",
					"identifiers": "<string>"
				},
				"_links": {}
			},
			"history": {
				"latest": true,
				"createdBy": {
					"type": "known"
				},
				"ownedBy": {
					"type": "known"
				},
				"createdDate": "<string>",
				"lastUpdated": {
					"when": "<string>",
					"number": 57,
					"minorEdit": true
				},
				"previousVersion": {
					"when": "<string>",
					"number": 57,
					"minorEdit": true
				},
				"contributors": {
					"publishers": {}
				},
				"nextVersion": {
					"when": "<string>",
					"number": 57,
					"minorEdit": true
				},
				"_expandable": {
					"lastUpdated": "<string>",
					"previousVersion": "<string>",
					"contributors": "<string>",
					"nextVersion": "<string>",
					"ownedBy": "<string>"
				},
				"_links": {}
			},
			"version": {
				"by": {
					"type": "known"
				},
				"when": "<string>",
				"friendlyWhen": "<string>",
				"message": "<string>",
				"number": 57,
				"minorEdit": true,
				"collaborators": {},
				"_expandable": {
					"content": "<string>",
					"collaborators": "<string>"
				},
				"_links": {},
				"contentTypeModified": true,
				"confRev": "<string>",
				"syncRev": "<string>",
				"syncRevSource": "<string>"
			},
			"ancestors": [],
			"operations": [
				{
					"operation": "administer",
					"targetType": "<string>"
				}
			],
			"children": {
				"attachment": {
					"results": [],
					"size": 2154,
					"_links": {}
				},
				"comment": {
					"results": [],
					"size": 2154,
					"_links": {}
				},
				"page": {
					"results": [],
					"size": 2154,
					"_links": {}
				},
				"_expandable": {
					"attachment": "<string>",
					"comment": "<string>",
					"page": "<string>"
				},
				"_links": {}
			},
			"childTypes": {
				"attachment": {
					"value": true,
					"_links": {}
				},
				"comment": {
					"value": true,
					"_links": {}
				},
				"page": {
					"value": true,
					"_links": {}
				},
				"_expandable": {
					"all": {},
					"attachment": {},
					"comment": {},
					"page": {}
				}
			},
			"descendants": {
				"attachment": {
					"results": [],
					"size": 2154,
					"_links": {}
				},
				"comment": {
					"results": [],
					"size": 2154,
					"_links": {}
				},
				"page": {
					"results": [],
					"size": 2154,
					"_links": {}
				},
				"_expandable": {
					"attachment": "<string>",
					"comment": "<string>",
					"page": "<string>"
				},
				"_links": {}
			},
			"container": {},
			"body": {
				"view": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"export_view": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"styled_view": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"storage": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"wiki": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"editor": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"editor2": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"anonymous_export_view": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"atlas_doc_format": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"dynamic": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"raw": {
					"value": "<string>",
					"representation": "view",
					"embeddedContent": [
						{}
					],
					"webresource": {},
					"mediaToken": {
						"collectionIds": [
							"<string>"
						],
						"contentId": "<string>",
						"expiryDateTime": "<string>",
						"fileIds": [
							"<string>"
						],
						"token": "<string>"
					},
					"_expandable": {
						"content": "<string>",
						"embeddedContent": "<string>",
						"webresource": "<string>",
						"mediaToken": "<string>"
					},
					"_links": {}
				},
				"_expandable": {
					"editor": "<string>",
					"view": "<string>",
					"export_view": "<string>",
					"styled_view": "<string>",
					"storage": "<string>",
					"editor2": "<string>",
					"anonymous_export_view": "<string>",
					"atlas_doc_format": "<string>",
					"wiki": "<string>",
					"dynamic": "<string>",
					"raw": "<string>"
				}
			},
			"restrictions": {
				"read": {
					"operation": "administer",
					"restrictions": {
						"user": {
							"results": [
								{
									"type": "known"
								}
							]
						},
						"group": {
							"results": [
								{
									"type": "group",
									"name": "<string>"
								}
							],
							"start": 2154,
							"limit": 2154,
							"size": 2154
						},
						"_expandable": {
							"user": "<string>",
							"group": "<string>"
						}
					},
					"_expandable": {
						"restrictions": "<string>",
						"content": "<string>"
					},
					"_links": {}
				},
				"update": {
					"operation": "administer",
					"restrictions": {
						"user": {
							"results": [
								{
									"type": "known"
								}
							]
						},
						"group": {
							"results": [
								{
									"type": "group",
									"name": "<string>"
								}
							],
							"start": 2154,
							"limit": 2154,
							"size": 2154
						},
						"_expandable": {
							"user": "<string>",
							"group": "<string>"
						}
					},
					"_expandable": {
						"restrictions": "<string>",
						"content": "<string>"
					},
					"_links": {}
				},
				"_expandable": {
					"read": "<string>",
					"update": "<string>"
				},
				"_links": {}
			},
			"metadata": {
				"currentuser": {
					"favourited": {
						"isFavourite": true,
						"favouritedDate": "<string>"
					},
					"lastmodified": {
						"version": {
							"when": "<string>",
							"number": 57,
							"minorEdit": true
						},
						"friendlyLastModified": "<string>"
					},
					"lastcontributed": {
						"status": "<string>",
						"when": "<string>"
					},
					"viewed": {
						"lastSeen": "<string>",
						"friendlyLastSeen": "<string>"
					},
					"scheduled": {},
					"_expandable": {
						"favourited": "<string>",
						"lastmodified": "<string>",
						"lastcontributed": "<string>",
						"viewed": "<string>",
						"scheduled": "<string>"
					}
				},
				"properties": {},
				"frontend": {},
				"labels": {
					"results": [
						{
							"prefix": "<string>",
							"name": "<string>",
							"id": "<string>",
							"label": "<string>"
						}
					],
					"start": 2154,
					"limit": 2154,
					"size": 2154,
					"_links": {}
				}
			},
			"macroRenderedOutput": {},
			"extensions": {},
			"_expandable": {
				"childTypes": "<string>",
				"container": "<string>",
				"metadata": "<string>",
				"operations": "<string>",
				"children": "<string>",
				"restrictions": "<string>",
				"history": "<string>",
				"ancestors": "<string>",
				"body": "<string>",
				"version": "<string>",
				"descendants": "<string>",
				"space": "<string>",
				"extensions": "<string>",
				"schedulePublishDate": "<string>",
				"schedulePublishInfo": "<string>",
				"macroRenderedOutput": "<string>"
			},
			"_links": {}
		}
	],
	"start": 2154,
	"limit": 2154,
	"size": 2154,
	"_links": {}
}

​
Workflow Library Example

Search Content with Confluence and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?