EIeightfold
User Groups

List User Groups

Changed on

Returns a list of user groups, ordered by name. Both active and inactive user groups are returned by default; the isActive field carries the state. Member counts are not returned here; use the Get User Group endpoint for those.

get/api/v2/core/user-groups

Request

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

onlyActiveboolean

Set to true to return only active user groups. Omitted or false returns both active and inactive.

userGroupNamestring

Return only user groups with this name. Matching is case-insensitive, so groups whose names differ only by case are all returned.

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

Changes