# 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](https://www.manageengine.com/products/desktop-central/help/api/onpremise/custom-groups-get-cglist.html). 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](https://www.manageengine.com/products/desktop-central/help/api/onpremise/custom-groups-get-dynamic-cgcriteria-pattern.html).

## Endpoints

`GET /api/1.4/customgroup/getCGDetails`

## Request URL

`https://{server-hostname}:8383/api/1.4/customgroup/getCGDetails`

## Scope

`Common.READ`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** (`string`, Mandatory): `application/json`
  - Must be application/json. Only JSON responses are supported.

## Sample Request

```curl
curl --request GET \
  --url https://appdomain/api/1.4/customgroup/getCGDetails \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP code 200

Response Body — `application/json`

- **message_type** (`string`): Always `getCGDetails` for this endpoint.
- **message_response** (`JSON Object`): Response payload container.
- **message_version** (`string`): API version: `1.4`.
- **status** (`string`): `success` when the request completed without errors.

### HTTP code 204

Response Body — `application/json`

- **message_type** (`string`): Always `getCGDetails` for this endpoint.
- **message_version** (`string`): API version: `1.4`.
- **status** (`string`): Always `error` for error responses.
- **error_code** (`string`): Internal error code: `20015` (group name does not exist).
- **error_description** (`string`): Human-readable error message.

### HTTP code 412

Response Body — `application/json`

- **message_type** (`string`): Always `getCGDetails` for this endpoint.
- **message_version** (`string`): API version: `1.4`.
- **status** (`string`): Always `error` for error responses.
- **error_code** (`string`): Internal error code: `20011` (group name empty).
- **error_description** (`string`): Human-readable error message.

### HTTP code 417

Response Body — `application/json`

- **message_type** (`string`): Always `getCGDetails` for this endpoint.
- **message_version** (`string`): API version: `1.4`.
- **status** (`string`): Always `error` for error responses.
- **error_code** (`string`): Internal error code: `20003` (no managed domains).
- **error_description** (`string`): Human-readable error message.

### HTTP code 500

Response Body — `application/json`

- **message_type** (`string`): Always `getCGDetails` for this endpoint.
- **message_version** (`string`): API version: `1.4`.
- **status** (`string`): Always `error` for error responses.
- **error_code** (`string`): Internal error code: `1003` (`INTERNAL_ERROR`).
- **error_description** (`string`): Resolved I18N message, typically: An internal error occurred while processing the request.

## Possible Response Codes

- `200` — HTTP code
- `204` — HTTP code
- `412` — HTTP code
- `417` — HTTP code
- `500` — HTTP code

## Sample Response: HTTP 200

Static computer group with members across multiple domains.

```json
{
  "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"
}
```

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

```json
{
  "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"
}
```

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

```json
{
  "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"
}
```

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

```json
{
  "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"
}
```

Static user group with managed user members.

```json
{
  "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"
}
```

## Sample Response: HTTP 204

No group found with the specified exact name.

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

Group exists but name case does not match.

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

## Sample Response: HTTP 412

The cgName query parameter was not provided or is blank.

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

## Sample Response: HTTP 417

Server has no managed AD/workgroup domains configured.

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

## Sample Response: HTTP 500

Unexpected server-side failure retrieving custom group details.

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

## Rate Limit

**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.