Retrieve summary details for a specific group

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

Fetches summary details of a computer group including name, type, creator, last modified time, and counts. Supports static and dynamic groups.

Request URL

https://{serverurl}/bsp/api/v1/bmp/groups/{group_id}/summary

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

group_idstringMandatory

Computer group ID from List Computer Groups response (group_id field)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/groups/{group_id}/summary \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Top-level response containing the group summary

Hide Sub-Attributes
group_summaryJSON Object

Object containing the summary details of the requested group

Show Sub-Attributes
device_countstring

Number of devices in the group. Returns 'NA' for dynamic groups where the count cannot be determined

profile_countstring

Number of profiles associated with the group. Absent when no profiles have been assigned to this group

extension_distributed_countstring

Number of extensions distributed to the group. Absent when no extensions have been distributed to this group

group_namestring

Name of the group

group_typestring

Type identifier of the group as string (e.g., '1' for static, '7' for dynamic)

created_bystring

First name of the user who created the group

modified_timestring

Last modified timestamp of the group. Falls back to the creation time if the group has never been modified

- HTTP code 401

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

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 404

Response Body - application/json
JSON Object

Returned when the specified group is not found

Hide Sub-Attributes
error_descriptionstring

Error message indicating the specified group does not exist

- HTTP code 429

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

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object

Returned when an unexpected server error occurs

Hide Sub-Attributes
error_descriptionstring

Message describing the internal server error

error_codestring

Error code identifying the type of server error

Possible Response Codes

200HTTP code
401HTTP code
403HTTP code
404HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Static group with profiles and extensions assigned

Copied!
  {
    "group_summary": {
      "modified_time": "Wed, 11 Mar 2026 10:30:00 AM",
      "group_name": "Marketing Browsers",
      "group_type": "1",
      "profile_count": "3",
      "created_by": "admin",
      "device_count": "25",
      "extension_distributed_count": "2"
    }
  }
                
Show full

Static group with no profiles or extensions yet

Copied!
  {
    "group_summary": {
      "modified_time": "Sun, 05 Apr 2026 03:28:11 PM",
      "group_name": "stati",
      "group_type": "1",
      "created_by": "admin",
      "device_count": "1"
    }
  }
                
Show full

Dynamic group with device_count as 'NA'

Copied!
  {
    "group_summary": {
      "modified_time": "Mon, 10 Mar 2026 02:15:00 PM",
      "group_name": "Dynamic Group 1",
      "group_type": "7",
      "profile_count": "5",
      "created_by": "admin",
      "device_count": "NA",
      "extension_distributed_count": "1"
    }
  }
                
Show full

Sample Response: HTTP 401

Unauthorized

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }
                
Show full

Sample Response: HTTP 404

Group not found

Copied!
  {
    "error_description": "Group ID not found"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }
                
Show full

Duration: 1 minute | Threshold: 60 | 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.