GET api/2.0/group/{groupid} This function requires authentication

Description

Returns the detailed information about the selected group: group name, category, description, manager, members, and parent group if it exists.

Parameters

Name	Description	Type	Example
groupid sent in url	Group ID	guid	9924256A-739C-462b-AF15-E652A3B1B6EB

Remark

This method returns full group information.

Example

GET api/2.0/group/%229924256A-739C-462b-AF15-E652A3B1B6EB%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

Group

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": "fadd9f49-2431-4610-a518-3ca9b3843c88",
    "Name": "Sample group",
    "Category": "74f31a85-991b-4e9b-b9e8-ae8e80d468f5",
    "Parent": "852d4b63-997a-4bae-aa7b-89bb87d85dbf",
    "Description": "Description",
    "Manager": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "Members": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      }
    ]
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>fadd9f49-2431-4610-a518-3ca9b3843c88</Id>
    <Name>Sample group</Name>
    <Category>74f31a85-991b-4e9b-b9e8-ae8e80d468f5</Category>
    <Parent>852d4b63-997a-4bae-aa7b-89bb87d85dbf</Parent>
    <Description>Description</Description>
    <Manager>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Manager>
    <Members>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Members>
  </response>
</result>