Get user group membership status


Check whether a user is member of user group.

Changes: New in Zulip 6.0 (feature level 127).

Usage examples

curl -sSX GET -G \
    --data-urlencode direct_member_only=false


user_group_id integer required in path

Example: 33

The ID of the target user group.

user_id integer required in path

Example: 12

The target user's ID.

direct_member_only boolean optional

Example: false

Whether to consider only the direct members of user group and not members of its subgroups. Default is false.


Return values

  • is_user_group_member: boolean

    Whether the user is member of user group.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

    "is_user_group_member": false,
    "msg": "",
    "result": "success"