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

{
	"items": [
		{
			"id": "<string>",
			"name": "<string>",
			"domain": "<string>",
			"hasNetworkProtectionPolicy": false,
			"hasIdentityProtectionPolicy": false,
			"guid": "<string>",
			"sid": "<string>",
			"createdAt": 2493739038892,
			"updatedAt": 3283357404594,
			"role": 4,
			"description": "<string>",
			"directMembersCount": 0,
			"principalName": "<string>",
			"type": "<string>",
			"externalId": "<string>"
		}
	],
	"nextOffset": 2
}

​
Workflow Library Example

List Groups with Zero Networks and Send Results Via Email

Preview this Workflow on desktop

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

{
	"items": [
		{
			"id": "<string>",
			"name": "<string>",
			"domain": "<string>",
			"hasNetworkProtectionPolicy": false,
			"hasIdentityProtectionPolicy": false,
			"guid": "<string>",
			"sid": "<string>",
			"createdAt": 2493739038892,
			"updatedAt": 3283357404594,
			"role": 4,
			"description": "<string>",
			"directMembersCount": 0,
			"principalName": "<string>",
			"type": "<string>",
			"externalId": "<string>"
		}
	],
	"nextOffset": 2
}

​
Workflow Library Example

List Groups with Zero Networks and Send Results Via Email

Preview this Workflow on desktop