List Groups

Return a list of groups.

​

Basic Parameters

Parameter	Description
Filters	Filter groups by specifying the field ID to filter by, and a list of values to include. Example: [ { “id”: “name”, “includeValues”: [“Group_Name”] } ]
Limit	Limit the returned number of results.
Offset	Use this to paginate through results. Insert the nextOffset value from the previous response to retrieve the next batch of results.

​

Advanced Parameters

Parameter	Description
Search	A 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
}