Queries for a list of groups using a list of parameters. The size of the result set can be retrieved by using the Get Group Count method.


GET /group


Query Parameters

Name Description
id Filter by the id of the group.
name Filter by the name of the group.
nameLike Filter by the name that the parameter is a substring of.
type Filter by the type of the group.
member Only retrieve groups which the given user id is a member of.
memberOfTenant Only retrieve groups which are members of the given tenant.
sortBy Sort the results lexicographically by a given criterion. Valid values are id, name and type. Must be used in conjunction with the sortOrder parameter.
sortOrder Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
firstResult Pagination of results. Specifies the index of the first result to return.
maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.


A JSON array of group objects. Each group object has the following properties:

Name Value Description
id String The id of the group.
name String The name of the group.
type String The type of the group.

Response Codes

Code Media type Description
200 application/json Request successful.



GET /group?name=Sales


Status 200.

  "type":"Organizational Unit"}]

On this Page: