Search user groups

get

https://api.revioapi.com/v1/UserGroups

Search for one or more user groups.

Query Params

search.user_group_id

array of int32s

Query by user group identifier.

search.user_group_id

search.group_type

string

enum

Query by kind of group.

Allowed:

search.name

array of strings

Query by all or part of name.

search.name

search.active

boolean

Return when Null: All; when True: Only Active; when False: Only Inactive.

search.page_size

int32

Format - int32. Defines how many items to return at a time.

search.page

int32

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sort

string

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Response

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

application/json

text/json

text/html

200OK