GET v1/groups/{groupId}

Get details about a particular group

Request Information

URI Parameters

Name	Description	Type	Additional information
groupId	Id for group you want to retrieve	integer	Required

Body Parameters

None.

Response Information

Resource Description

GroupDetailModel

Name	Description	Type	Additional information
LogoImageUrl		string	None.
CoverPhotoUrl		string	None.
DNA		Collection of FlatTagModel	None.
GroupId		integer	None.
Name	Name of this group	string	None.
Privacy	Who can see this group in the groups directory	GroupPrivacy	None.
ApprovalRequired	Should members be approved before they can join and view content	boolean	None.
PrivacyLevel	Who can see this group in the groups directory	GroupPrivacyLevel	None.
Status		GroupStatus	None.
Description		string	None.
Tagline		string	None.
GroupUrl		string	None.
Community	Community this group is in	SimpleCommunityModel	None.

Try API

Try this endpoint by entering your credentials and using the API Explorer.

Try With API Explorer

Response Formats

application/json, text/json

Sample:

{
  "LogoImageUrl": "https://x362.blob.core.windows.net/groups/3/sample string 1",
  "CoverPhotoUrl": "https://x362.blob.core.windows.net/groups/3/sample string 2",
  "DNA": [
    {
      "TagId": 1,
      "Name": "sample string 2",
      "ParentTagId": 1,
      "TagSetId": 3,
      "TagSetName": "sample string 4",
      "CommunityId": 5,
      "CommunityName": "sample string 6"
    },
    {
      "TagId": 1,
      "Name": "sample string 2",
      "ParentTagId": 1,
      "TagSetId": 3,
      "TagSetName": "sample string 4",
      "CommunityId": 5,
      "CommunityName": "sample string 6"
    }
  ],
  "GroupId": 3,
  "Name": "sample string 4",
  "Privacy": "Private",
  "ApprovalRequired": true,
  "PrivacyLevel": "Private",
  "Status": "Draft",
  "Description": "sample string 6",
  "Tagline": "sample string 7",
  "GroupUrl": "https://sample string 2.causemachine.com/groups/3/sample string 8",
  "Community": {
    "CommunityId": 1,
    "CommunityName": "sample string 2"
  }
}