API End Points

Get User Group

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

Given a user group id, it returns the user group along with its member counts. staticMemberCount is read from the database and is always current; dynamicMemberCount is read from the search index, can lag a recent change, and is null if that index cannot be reached, which is distinct from a count of zero.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of a user group in Eightfold

Query Params
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.

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
string
required

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

Response

Updated about 2 hours ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago