Sign in

v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
UserGroups

View user group

Find a single user group by ID.

get/v1/UserGroups/{id}

Path parameters

idinteger required

ID of the user group to view.

Response

OK

okboolean
user_group_idinteger

Primary identifier for this user group.

group_type'TASK' | 'TICKET' | 'PREORDER' | 'ORDER' | 'NOTIFICATION' | 'REQUEST' required

Indicates the kind of group this represents. Used for programmatic decisions by Rev.io.

namestring required

Short description of the group.

group_emailstring

Comma separated list of contact emails.

descriptionstring

Detailed description of the group.

usersinteger[]

List of user identifiers, indicating membership to the group.

activeboolean required

Indicates whether this group can be assigned.