List User Groups

get

https://apiv2.{domain}.ai/api/v2/core/user-groups

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

integer

Specifies the offset value to start for the page

limit

integer

Specifies the number of entries to be returned for the page

onlyActive

boolean

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

userGroupName

string

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

exclude

string

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.

keyList

string

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

Authorization

string

required

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

Response

200OK