GET /user_groups/{user_group_id}/members/{user_id}

Check whether a user is member of user group.

Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint.

Prior to Zulip 12.0 (feature level 458), this endpoint did not support querying group membership of bot users.

Prior to Zulip 10.0 (feature level 303), this would return true when passed a deactivated user who was a member of the user group before being deactivated.

New in Zulip 6.0 (feature level 127).

Servers

Path parameters

Name Type Required Description
user_group_id Integer Yes

The ID of the target user group.

user_id Integer Yes

The target user's ID.

Query parameters

Name Type Required Description
direct_member_only Boolean No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.