Groups

Groups are named collections of Users.

View as Markdown

Groups are named collections of Users. They allow you to refer to multiple Users as a unit in various product areas like filtering and reporting. A group typically represents a team in your company. For example, you can have a Sales group and a Support group. A User can be a member of multiple Groups.

Endpoints for groups require a ?_fields=name,members GET parameter to return corresponding field data. Specify only the fields you want to reduce the amount of data returned.

Endpoints that support filtering for both groups and users use the ?user_id__in=user_abc,user_xyz GET parameter. To filter for users that belong to a group, include the group ID. You can mix individual users and groups in the same request, e.g. ?user_id__in=user_abc,group_xyz.