Retrieves data group details by ID

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves the full details of a specific data group by its unique identifier, including all associated data rules.

Endpoints

Request URL

https://{serverurl}/endpointdlp/api/data-classification/data-group/data-group-details/{dataGroupId}

Scope

DesktopCentralCloud.EndpointDLP.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/dataGroupDetail.v1+jsonapplication/dataGroupDetail.v1+jsonCopied!

- Path Parameters

dataGroupIdstringMandatory

Unique identifier of the data group. Fetch from Get All Data Groups

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/endpointdlp/api/data-classification/data-group/data-group-details/{dataGroupId} \
  --header 'Accept: application/dataGroupDetail.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
dataGroupDetailJSON Object

Data group detail wrapper

Show Sub-Attributes
dataGroupIdstring

Unique identifier of the data group

dataGroupNamestring

Name of the data group

dataGroupDescriptionstring

Description of the data group

creationTimestring

Creation timestamp (epoch millis as string)

createdUserstring

Username of the creator

createdUserIdstring

User ID of the creator

labelIdstring

Associated label identifier

lastModifiedTimestring

Last modification timestamp (epoch millis as string)

lastModifiedUserstring

Username of the last modifier

lastModifiedUserIdstring

User ID of the last modifier

customerIdstring

Customer identifier

dataRuleDetailsJSON Array

List of predefined rules with occurrence thresholds

Show Sub-Attributes
JSON Object
Show Sub-Attributes
dataRuleIdstring

Unique identifier of the data rule

noOfOccurrencestring

Number of occurrences threshold

dataRuleSummaryBeanListJSON Array

List of custom rule summaries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
dataRuleNamestring

Name of the data rule

dataRuleIdstring

Unique identifier of the data rule

dataRuleTypeinteger

Type of the data rule (1=Predefined, 2=Custom)

dataRuleDescriptionstring

Description of the data rule

noOfOccurrencestring

Number of occurrences threshold

subRuleTypeIdinteger

Sub-rule type identifier (1=Regex, 2=Keyword, 3=Fingerprint)

regexSubRuleBeanJSON Object

Regex sub-rule details (present when subRuleTypeId=1)

Show Sub-Attributes
regexValueListarray

List of regex patterns

dictionaryWordListarray

List of dictionary words

keywordSubRuleBeanJSON Object

Keyword sub-rule details (present when subRuleTypeId=2)

Show Sub-Attributes
caseSensitiveboolean

Whether keyword matching is case-sensitive

fileDetailBeanJSON Object

File details for the keyword reference file

Show Sub-Attributes
fileNamestring

Name of the reference file

fileLocationstring

Server-side path of the reference file

fingerprintSubRuleBeanJSON Object

Fingerprint sub-rule details (present when subRuleTypeId=3)

Show Sub-Attributes
fileDetailBeanJSON Object

File details for the fingerprint reference file

Show Sub-Attributes
fileNamestring

Name of the reference file

fileLocationstring

Server-side path of the reference file

extensionListarray

List of file extensions to scan

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Internal error code returned when fetching data group details by ID fails

errorMessagestring

Failure message describing why the data group could not be retrieved

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Successful retrieval of data group details containing one rule of each sub-rule type (regex, keyword, fingerprint)

Copied!
  {
    "dataGroupDetail": {
      "dataGroupId": "1",
      "createdUserId": "101",
      "lastModifiedTime": "1775466405627",
      "creationTime": "1775457447117",
      "dataGroupDescription": null,
      "dataRuleSummaryBeanList": [
        {
          "regexSubRuleBean": {
            "dictionaryWordList": [],
            "regexValueList": [
              "\\d{4}-\\d{4}-\\d{4}-\\d{4}"
            ]
          },
          "keywordSubRuleBean": null,
          "dataRuleId": "1000002",
          "noOfOccurrence": "1",
          "dataRuleDescription": null,
          "extensionList": null,
          "dataRuleName": "Credit Card Number Rule",
          "dataRuleType": 1,
          "fingerprintSubRuleBean": null,
          "subRuleTypeId": 1
        },
        {
          "regexSubRuleBean": null,
          "keywordSubRuleBean": {
            "fileDetailBean": {
              "fileName": "confidential-keywords.txt",
              "fileLocation": "/dlp/refdata/uploads/confidential-keywords.txt"
            },
            "caseSensitive": false
          },
          "dataRuleId": "1000003",
          "noOfOccurrence": "1",
          "dataRuleDescription": null,
          "extensionList": null,
          "dataRuleName": "Confidential Keyword Rule",
          "dataRuleType": 2,
          "fingerprintSubRuleBean": null,
          "subRuleTypeId": 2
        },
        {
          "regexSubRuleBean": null,
          "keywordSubRuleBean": null,
          "dataRuleId": "1000004",
          "noOfOccurrence": "1",
          "dataRuleDescription": null,
          "extensionList": null,
          "dataRuleName": "Source Code Fingerprint Rule",
          "dataRuleType": 2,
          "fingerprintSubRuleBean": {
            "fileDetailBean": {
              "fileName": "source-code-template.docx",
              "fileLocation": "/dlp/refdata/uploads/source-code-template.docx"
            }
          },
          "subRuleTypeId": 3
        }
      ],
      "labelId": "1",
      "lastModifiedUserId": "101",
      "customerId": "5001",
      "lastModifiedUser": "john.doe",
      "dataRuleDetails": [],
      "dataGroupName": "Credit Card Data Group",
      "createdUser": "john.doe"
    }
  }
▼ Show full

Sample Response: HTTP 500

Internal server error

Copied!
  {
    "errorMessage": "Exception occurred while fetching DataGroup",
    "errorCode": "INTERNAL_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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.