Groups Data Type

A collection of user groups.

Properties
Name Type Description
groups array of Group Collection of group.
total number Only applies in the response to searching for groups and setting the includeTotal parameter to true in the request. Represents the total number of groups that matched the search, which may be different from the number of groups actually returned.

Example

{
  "groups" : [ {
    "guid" : "6d0c4ddb-10ae-471d-948d-df27868dcf8a",
    "name" : "Sales",
    "description" : "All active sales reps",
    "directoryLinked" : false
  }, {
    "guid" : "4e9e07fd-f2f9-4eea-94eb-85524dcecb9e",
    "name" : "Marketing",
    "description" : "Internal marketing department",
    "directoryLinked" : true
  } ],
  "total" : 12345
}