GET api/2.0/groups This function requires authentication

Description

Returns the general information about all the groups, such as group ID and group manager.

Parameters

Name	Description	Type	Example
userId sent in url	User ID optional	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
manager sent in url	Specifies if the user is a manager or not optional	Bool value	true

Remark

This method returns partial group information.

Example

GET api/2.0/groups
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "userId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "manager": true
}

Returns

List of groups

Example Response

{
  "status": 0,
  "response": [
    {
      "Name": "some text",
      "Parent": "9924256A-739C-462b-AF15-E652A3B1B6EB",
      "Category": "9924256A-739C-462b-AF15-E652A3B1B6EB",
      "Id": "9924256A-739C-462b-AF15-E652A3B1B6EB",
      "Manager": {
        "Id": "9924256A-739C-462b-AF15-E652A3B1B6EB",
        "DisplayName": "some text",
        "Title": "some text",
        "AvatarSmall": "some text",
        "ProfileUrl": "some text",
        "HasAvatar": true
      }
    }
  ]
}