groups_get_group
Get the group details.
Resource URL
https://www.domain.com/api/userplus/groups_get_group/
Method
POST
Required Parameters
- key – get API key from Settings > User Plus
- group_id required. (int) ID of the group
- cookie – required.
Optional Parameters
- avatar - optional. To get group avatar.
- cover - optional. To get group cover image.
- groupmeta – optional. To get groupmeta.
- extras – optional. To get extras from group
- load_users - optional. To include more details.
Endpoint Returns
Returns details of given group based on parameters.
Sample Response
{
"status": "ok",
"result": {
"id": 2,
"creator_id": 16,
"name": "My first Group update",
"slug": "my-first-group",
"description": "first group desc",
"status": "public",
"parent_id": 0,
"enable_forum": 0,
"date_created": "2019-02-26 10:08:46",
"args": null,
"avatar": "https://www.wppim.com/wp-content/uploads/group-avatars/2/logo-bpfull.png",
"cover": "https://www.wppim.com/wp-content/uploads/buddypress/groups/2/cover-image/twitter-cover-fullmoon-bp-cover-image.jpg",
"groupmeta": {
"total_member_count": [
"4"
],
"last_activity": [
"2019-08-20 15:29:54"
],
"invite_status": [
"members"
]
}
}
}
Related Endpoints
- groups
- groups_create_group
- groups_delete_group
- groups_delete_groupmeta
- groups_edit_group_settings
- groups_get_avatar
- groups_get_cover
- 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_members
- groups_post_update
- groups_send_membership_request
- groups_update_group
- groups_update_groupmeta