Get Started
Usage API
More information

GET api/2.0/group/search This function requires authentication

Description

Returns a list of all the groups by the group name specified in the request.

Parameters
Name Description Type Example
groupName
sent in url
Group name string some text
Example
GET api/2.0/group/search?groupName=some+text
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of groups

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Group Name",
      "manager": "Jake.Zazhitski"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>00000000-0000-0000-0000-000000000000</id>
    <name>Group Name</name>
    <manager>Jake.Zazhitski</manager>
  </response>
</result>