Return a list of groups.

​
Basic Parameters

ParameterDescription
FiltersFilter groups by specifying the field ID to filter by, and a list of values to include.Example:[ { "id": "name", "includeValues": ["Group_Name"] }]
LimitLimit the returned number of results.
OffsetUse this to paginate through results. Insert the nextOffset value from the previous response to retrieve the next batch of results.

​
Advanced Parameters

ParameterDescription
SearchA free-text query used to search for results.

​
Example Output

{
	"count": 0,
	"items": [
		{
			"addedAt": 0,
			"addedBy": {
				"id": "string",
				"name": "User Name"
			},
			"createdAt": 0,
			"description": "string",
			"directMembersCount": 0,
			"domain": "string",
			"externalId": "string",
			"guid": "string",
			"hasProtectionPolicy": false,
			"id": "string",
			"name": "string",
			"principalName": "string",
			"role": 0,
			"sid": "string",
			"updatedAt": 0
		}
	],
	"nextCursor": "string",
	"nextOffset": 0
}

​
Workflow Library Example

List Groups with Zero Networks and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?