Search for groups using a query.
External DocumentationTo learn more, visit the Confluence documentation.

​
Basic Parameters

ParameterDescription
QueryThe search term used to query results.

​
Advanced Parameters

ParameterDescription
LimitThe maximum number of groups to return per page. Note: this is restricted to a maximum limit of 200 groups.
Should Return Total SizeWhether to include total size parameter in the results. Note: fetching total size property is an expensive operation; use it if your use case needs this value.
StartThe starting index of the returned groups.

​
Example Output

{
	"results": [
		{
			"type": "group",
			"name": "<string>",
			"id": "<string>",
			"_links": {}
		}
	],
	"start": 2154,
	"limit": 2154,
	"size": 2154,
	"totalSize": 150,
	"_links": {}
}

​
Workflow Library Example

Search Groups with Confluence and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop