List User Group Members

get

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

Returns the members of a user group. Assigned members are read from the database, so an assignment is visible immediately; members matched by the group's rules are read from the search index and can lag a recent change. Every member carries a membershipType, and only static members can be removed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

userGroupId

string

required

ID of a user group in Eightfold

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

membershipType

string

Filter to static (explicitly assigned) or dynamic (matched by the group's rules) members. Defaults to all. Use static to skip the search index query entirely.

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