Introduction

The Members API provides functionality for managing group members, including adding, removing, and querying group members.

Settings for a typical use case

  • If a group's privacy level is set to SECRET, group admins or group members can add additional members to their group.
  • If a group's privacy level is set to PUBLIC or PRIVATE, group admins determine whether group members can add additional members to their group.
  • This setting can be found in your site's Dashboard under Groups Application > Your Group > Admin Tools > Member Permissions.
  • If set to all members, group members can add additional members to the group using the addGroupMembers() function (no approval required).
  • If set to admins only, only admins can add additional members to the group using the addGroupMembers() function.
  • The default is set to admins only.

The Members API provides functionality allowing you to:

  • Add members to a group.
  • List all members of a group.
  • List a site member's group memberships.
  • Query members of a group.
  • Query a site member's group memberships.
  • Remove members of a group.
Was this helpful?
Yes
No