Sign in
User Groups

Find user groups

Returns user groups matching the given search criteria. Only parameters that are specified in this request and have not <code>null</code> values are used for filtering. All other parameters are ignored. By default a result containing 1000 user groups is returned.

get/userGroups

Query parameters

offsetinteger

The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.

limitinteger

The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.

countLimitinteger

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

namestring

The name of the user group.

nameMatchMode'START' | 'END' | 'ANYWHERE' | 'EXACT'

The match mode used to compare <code>name</code>. If the match mode is <code>EXACT</code> the search is case-sensitive, otherwise the search is case-insensitive.

userIdstring uuid

The ID of the user who should belong to searched user groups.

includeEveryoneboolean

Indicates if we should include the everyone group or not.

Response

Search completed

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.

Changes

No recorded changes to this endpoint across all 1 revision of this API.