groups_members
Fetch the members of a group.
Resource URL
https://www.domain.com/api/userplus/groups_members/
Method
POST
Required Parameters
- key – get API key from Settings > User Plus
- 'group_id' - ID of the group to limit results to. Also accepts multiple values either as an array or as a comma-delimited string.
Optional Parameters
- 'page' - Page of results to be queried. Default: 1.
- 'per_page' - Number of items to return per page of results. Default: 20.
- 'max' - Max number of items to return.
- 'exclude' - Array of user IDs to exclude.
- 'exclude_admins_mods' - True (or 1) to exclude admins and mods from results. Default: 1.
- 'exclude_banned' - True (or 1) to exclude banned users from results. Default: 1.
- 'group_role' - Array of group roles to include.
- 'search_terms' - Filter results by a search string.
- 'type' - Sort the order of results. 'last_joined', 'first_joined', or any of the $type params available in BP_User_Query. Default: 'last_joined'.
Endpoint Returns
List the members of groups on true, error on False
Related Endpoints
- groups
- groups_create_group
- groups_delete_group
- groups_delete_groupmeta
- groups_edit_group_settings
- groups_get_avatar
- groups_get_cover
- groups_get_group
- groups_get_groupmeta
- groups_invite_user
- groups_invite_users_admin
- groups_is_user_admin
- groups_is_user_member
- groups_is_user_mod
- groups_join_group
- groups_join_group_admin
- groups_leave_group
- groups_post_update
- groups_send_membership_request
- groups_update_group
- groups_update_groupmeta