Get Started
Portal api methods
Help

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

Description

Returns the detailed information about the selected group: group name, category, description, manager, users and parent group if any

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

That method returns full group info

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

Group

Example Response

application/json

{
  "status": 0,
  "response": {
    "id": "4038ce4f-9b4f-4441-9d4b-d1e00ac12f80",
    "name": "Sample group",
    "category": "88a8dfe1-07e0-4d4d-8542-4d3a48709035",
    "parent": "af5fa5bc-bdff-4a69-8039-971291faef84",
    "description": null,
    "manager": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "members": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      }
    ]
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>4038ce4f-9b4f-4441-9d4b-d1e00ac12f80</id>
    <name>Sample group</name>
    <category>88a8dfe1-07e0-4d4d-8542-4d3a48709035</category>
    <parent>af5fa5bc-bdff-4a69-8039-971291faef84</parent>
    <description />
    <manager>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </manager>
    <members>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </members>
  </response>
</result>