Search Groups - Blink Documentation

Basic Parameters
Advanced Parameters
Example Output
Workflow Library Example

Search for groups using a query.

External DocumentationTo learn more, visit the Confluence documentation.

Basic Parameters

Parameter	Description
Query	The search term used to query results.

Advanced Parameters

Parameter	Description
Limit	The maximum number of groups to return per page. Note: this is restricted to a maximum limit of 200 groups.
Should Return Total Size	Whether 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.
Start	The 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": {}
}