Retrieves detailed information for a specific custom group by name

Returns complete details of a custom group identified by name. Fetch the cgName from Retrieve All Custom Groups. For static groups, includes the list of member resources and associated domains. For dynamic groups, includes the criteria list, renderability status, and filter criteria used for automatic member population — column definitions referenced in the returned criteriaList (columnId, columnValue, comparator) are documented at Get Dynamic CG Criteria Pattern.

Endpoints

get /api/1.4/customgroup/getCGDetails

Copy full URL

Request URL

https://{serverurl}/api/1.4/customgroup/getCGDetails

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

Must be application/json. Only JSON responses are supported.

- Query Parameters

cgNamestringMandatory

Exact name of the custom group to retrieve. Case-sensitive match. Fetch names from Retrieve All Custom Groups.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url 'https://appdomain/api/1.4/customgroup/getCGDetails?cgName=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/1.4/customgroup/getCGDetails?cgName=SOME_STRING_VALUE"))
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/api/1.4/customgroup/getCGDetails?cgName=SOME_STRING_VALUE", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    parameters = "cgName=value";

    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomain/api/1.4/customgroup/getCGDetails" + "?" + parameters
        type: GET
        headers: headersMap
        
        
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/customgroup/getCGDetails?cgName=SOME_STRING_VALUE' -Method GET -Headers $headers

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

message_typestring

Always 'getCGDetails' for this endpoint.

message_responseJSON object

Response payload container.

Show Sub-Attributes

getcgdetailsJSON object

Response payload.

Show Sub-Attributes

operation_statusstring

Operation result: 'success' when the request completed without errors.

responseJSON object

Wrapper containing the success message and full group detail.

Show Sub-Attributes

messagestring

Fixed success string: 'Operation has been completed successfully'.

resultJSON object

Full custom group object with conditional fields based on group category.

Show Sub-Attributes

group_idlong

Unique resource ID of the custom group. Use as cgId in Delete CG, as groupId in the request body of Update Static CG / Update Static Unique CG / Update Dynamic CG, or as sourceCGId in Clone Dynamic CG.

group_namestring

Display name of the custom group.

group_typestring

Human-readable type: 'Computers' or 'Users'.

group_categorystring

Human-readable category: 'Static', 'Dynamic', or 'Static Unique'.

domain_namestring

NetBIOS domain name. 'NA' for dynamic groups.

group_created_onlong

Creation timestamp in milliseconds since epoch.

group_modified_onlong

Last modification timestamp in milliseconds since epoch.

domainsarray

[Static/Static Unique only] Active domains associated with this CG, sourced from the CG-to-domain mapping (not derived from current groupMembers). Returned as JSON array of NetBIOS strings.

groupMembersJSON array

[Static/Static Unique] Array of member resources with ID, name, domain, and type.

Show Sub-Attributes

JSON object

Show Sub-Attributes

resourceIdstring

Unique resource ID of the member (returned as string). Use in resourceIds array when calling Create Static CG, Create Static Unique CG, Update Static CG, or Update Static Unique CG.

namestring

Display name of the member (computer hostname or AD username).

domainNamestring

NetBIOS domain the member belongs to.

osPlatformstring

[Computer groups only] OS platform identifier (e.g., 1=Windows, 2=Mac, 3=Linux). Absent for user groups.

isRenderableboolean

[Dynamic only] true if the SQL query can be rendered in the UI; false for complex or deprecated criteria.

criteriaListJSON array

[Dynamic only] Array of filter criteria objects defining how members are automatically selected.

Show Sub-Attributes

JSON object

Show Sub-Attributes

columnIdlong

Criteria column ID. Same value space as filterCriteriaRequestItem.columnId.

logicalOperatorstring

How this criteria joins with the next: 'AND' or 'OR'.

comparatorstring

Comparison operator. Values: 'equal', 'not equal', 'contains', 'not contains', 'starts with', 'not starts with', 'ends with', 'greater than', 'greater or equal', 'less than', 'less or equal', 'between', 'not between', 'on', 'after', 'before'.

criteriaValuearray

Array of string values being compared against.

additionalValuesJSON object

[Script-based criteria only] Script execution parameters: exit code, script ID, name, and description.

Show Sub-Attributes

exitCodestring

Comma-separated expected exit codes (e.g., '0' for success, '0,1' for success or warning).

scriptIdstring

Resource ID of the custom script in the scripts repository.

scriptNamestring

File name of the script (e.g., 'ComplianceCheck.bat').

descriptionstring

Human-readable description of what the script checks.

columnNamestring

Human-readable column name (e.g., 'Operating System', 'Software Name'). Returned by getCGDetails only.

columnValuestring

Internal DB column reference (e.g., 'OS_NAME', 'SOFTWARE_NAME'). Discover valid columns via Get Dynamic CG Criteria Pattern. Returned by getCGDetails only.

I18NComparatorstring

Localized display text for the comparator (e.g., 'is', 'is not', 'contains'). Returned by getCGDetails only.

204HTTP code

412HTTP code

417HTTP code

500HTTP code

Sample Response: HTTP 200

Static computer group with members across multiple domains.

Copied!

  {
    "message_type": "getCGDetails",
    "message_response": {
      "getcgdetails": {
        "response": {
          "result": {
            "groupMembers": [
              {
                "resourceId": "101",
                "domainName": "CORP",
                "name": "SRV-DC01",
                "osPlatform": "1"
              },
              {
                "resourceId": "102",
                "domainName": "CORP",
                "name": "SRV-APP01",
                "osPlatform": "1"
              },
              {
                "resourceId": "201",
                "domainName": "BRANCH1",
                "name": "SRV-FILE01",
                "osPlatform": "1"
              }
            ],
            "domain_name": "CORP",
            "group_category": "Static",
            "group_id": 301,
            "group_name": "Windows Servers",
            "group_modified_on": 1710412000000,
            "domains": [
              "CORP",
              "BRANCH1"
            ],
            "group_created_on": 1710325600000,
            "group_type": "Computers"
          },
          "message": "Operation has been completed successfully"
        },
        "operation_status": "success"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }

▼ Show full

Dynamic computer group with multi-criteria filter and renderability flag.

Copied!

  {
    "message_type": "getCGDetails",
    "message_response": {
      "getcgdetails": {
        "response": {
          "result": {
            "domain_name": "NA",
            "group_category": "Dynamic",
            "group_id": 302,
            "group_name": "Windows 11 PCs",
            "group_modified_on": 1710500000000,
            "isRenderable": true,
            "group_created_on": 1710325600000,
            "group_type": "Computers",
            "criteriaList": [
              {
                "comparator": "contains",
                "I18NComparator": "contains",
                "logicalOperator": "AND",
                "columnId": 1,
                "columnValue": "OS_NAME",
                "columnNameI18N": "Operating System",
                "criteriaValue": [
                  "Windows 11"
                ],
                "columnName": "OS_NAME",
                "I18NOperator": "AND"
              },
              {
                "comparator": "equal",
                "I18NComparator": "is",
                "logicalOperator": "AND",
                "columnId": 3,
                "columnValue": "PROCESSOR_ARCH_NAME",
                "columnNameI18N": "System Type",
                "criteriaValue": [
                  "64-bit"
                ],
                "columnName": "PROCESSOR_ARCH_NAME",
                "I18NOperator": "AND"
              }
            ],
            "criteriaPattern": "1 AND 2"
          },
          "message": "Operation has been completed successfully"
        },
        "operation_status": "success"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }

▼ Show full

Dynamic group with script-based criteria showing additionalValues and isRenderable=false.

Copied!

  {
    "message_type": "getCGDetails",
    "message_response": {
      "getcgdetails": {
        "response": {
          "result": {
            "domain_name": "NA",
            "group_category": "Dynamic",
            "group_id": 310,
            "group_name": "Compliant Machines",
            "group_modified_on": 1709100000000,
            "isRenderable": false,
            "group_created_on": 1709000000000,
            "group_type": "Computers",
            "criteriaList": [
              {
                "comparator": "equal",
                "I18NComparator": "is",
                "applicableOS": 1,
                "logicalOperator": "AND",
                "columnId": 22,
                "columnValue": "CUSTOM_SCRIPT",
                "columnNameI18N": "Custom Script",
                "criteriaValue": [
                  "0"
                ],
                "additionalValues": {
                  "scriptId": "5001",
                  "exitCode": "0",
                  "scriptName": "ComplianceCheck.bat",
                  "description": "Verifies security compliance"
                },
                "columnName": "CUSTOM_SCRIPT",
                "I18NOperator": "AND"
              }
            ],
            "criteriaPattern": "1"
          },
          "message": "Operation has been completed successfully"
        },
        "operation_status": "success"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }

▼ Show full

Static Unique (category=5) computer group — used for technician-level sharing constraints with exclusive member resources.

Copied!

  {
    "message_type": "getCGDetails",
    "message_response": {
      "getcgdetails": {
        "response": {
          "result": {
            "groupMembers": [
              {
                "resourceId": "401",
                "domainName": "CORP",
                "name": "FIN-WS01",
                "osPlatform": "1"
              },
              {
                "resourceId": "402",
                "domainName": "CORP",
                "name": "FIN-WS02",
                "osPlatform": "1"
              },
              {
                "resourceId": "403",
                "domainName": "CORP",
                "name": "FIN-SRV01",
                "osPlatform": "1"
              }
            ],
            "domain_name": "CORP",
            "group_category": "Static Unique",
            "group_id": 303,
            "group_name": "Finance OU Computers",
            "group_modified_on": 1710500000000,
            "domains": [
              "CORP"
            ],
            "group_created_on": 1710240000000,
            "group_type": "Computers"
          },
          "message": "Operation has been completed successfully"
        },
        "operation_status": "success"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }

▼ Show full

Static user group with managed user members.

Copied!

  {
    "message_type": "getCGDetails",
    "message_response": {
      "getcgdetails": {
        "response": {
          "result": {
            "groupMembers": [
              {
                "resourceId": "501",
                "domainName": "CORP",
                "name": "jsmith"
              },
              {
                "resourceId": "502",
                "domainName": "CORP",
                "name": "mjones"
              }
            ],
            "domain_name": "CORP",
            "group_category": "Static",
            "group_id": 304,
            "group_name": "HR Users",
            "group_modified_on": 1710150000000,
            "domains": [
              "CORP"
            ],
            "group_created_on": 1710150000000,
            "group_type": "Users"
          },
          "message": "Operation has been completed successfully"
        },
        "operation_status": "success"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }

▼ Show full

Sample Response: HTTP 204

No group found with the specified exact name.

Copied!

  {
    "error_description": "MyGroup does not exist",
    "message_type": "getCGDetails",
    "error_code": "20015",
    "message_version": "1.4",
    "status": "error"
  }

▼ Show full

Group exists but name case does not match.

Copied!

  {
    "error_description": "windows servers does not exist : Maybe Case Sensitive",
    "message_type": "getCGDetails",
    "error_code": "20015",
    "message_version": "1.4",
    "status": "error"
  }

▼ Show full

Sample Response: HTTP 412

The cgName query parameter was not provided or is blank.

Copied!

  {
    "error_description": "Group name should not be empty",
    "message_type": "getCGDetails",
    "error_code": "20011",
    "message_version": "1.4",
    "status": "error"
  }

▼ Show full

Sample Response: HTTP 417

Server has no managed AD/workgroup domains configured.

Copied!

  {
    "error_description": "No managed domain(s) available",
    "message_type": "getCGDetails",
    "error_code": "20003",
    "message_version": "1.4",
    "status": "error"
  }

▼ Show full

Sample Response: HTTP 500

Unexpected server-side failure retrieving custom group details.

Copied!

  {
    "error_description": "An internal error occurred while processing the request.",
    "message_type": "getCGDetails",
    "error_code": "1003",
    "message_version": "1.4",
    "status": "error"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.