Get user groups

get

https://usermgmt-api.optimizely.com/api/usergroups

Get a page of user groups.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Name of the user group.

description

string

Description of the user group.

organizationId

string

Organization ID that the user group belongs to.

groupOwner

string

Email address of the user group owner.

properties

array of objects

Additional properties of the user group.

properties

users

array of strings

Email addresses of users in the user group.

users

instanceIds

array of strings

Instance IDs of the user group.

instanceIds

roleIds

array of strings

IDs of the roles in the user group.

roleIds

attributeIds

array of strings

IDs of attributes for the user group.

attributeIds

useExactMatchSearch

boolean

True or false, indicating whether to perform an exact match or partial word search on the name parameter, if specified.

matchAnyInstanceId

boolean

True or false, indicating whether to match any ID you provide in instanceIds.

groupTypes

array of strings

User group types. Possible values: 0 for Custom Defined, 1 for Internal Defined, 2 for Product Defined user group types.

groupTypes

productIds

array of strings

Product IDs associated with the user group.

productIds

excludeTeams

boolean | null

True or false, indicating whether to exclude Teams usergroups from the results. Defaults to true.

size

int32

Number of results to include per page.

offset

int32

Offset paging of results.

Responses

401

Unauthorized access to endpoint.

403

Forbidden access to endpoint.

500

A server error occurred, please try again.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The user groups response.

400The request was invalid or cannot be otherwise served. An accompanying error message will explain further.