Skip to main content

getCustomGroupsList

This method retrieves the list of groups under a specified group.

Parameters

Parameter

Type

Optional

Description

parentId

String

Yes

The ID of the parent group for which the child groups will be listed. 'Computers and Groups' and 'Deleted' groups are returned if the passed parameter is null or a company ID.

Return value

This method returns an Array containing the list of groups located under the specified parent. Each entry in the list has the following fields:

  • id - the ID of the group

  • name - the name of the group

Example

Request:

  {
       "params": {
           "parentId": "5582c0acb1a43d9f7f7b23c6"
       },
       "jsonrpc": "2.0",
       "method": "getCustomGroupsList",
       "id": "9600512e-4e89-438a-915d-1340c654ae34"
  }

Response:

  {
      "id":"8edf135b-f7cb-41f2-8b67-98054694f61e",
      "jsonrpc":"2.0",
      "result": [
              {
                  "id" : "5582c385b1a43deb7f7b23c6",
                  "name" : "myGroup1"
              },
              {
                  "id" : "5582d3b3b1a43d897f7b23c8",
                  "name" : "myGroup2"
              }
      ]
  }
In this section: