Retrieves all configured webdomain groups.
get /bsp/api/v1/bmp/webdomain-groups
https://{server-hostname}:8383/bsp/api/v1/bmp/webdomain-groups
BrowserManager.READCopied!
Authorization: d92d4xxxxxxxxxxxxx15f52
curl --request GET \
--url https://appdomain/bsp/api/v1/bmp/webdomain-groups \
--header 'Accept: application/json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'Webdomain group summaries. Empty when no groups match the search criteria
Unique identifier for the webdomain group
Display name of the webdomain group
Error code indicating a query parameter value is out of the allowed range
Message describing which parameter exceeded the allowed range
The request URL that triggered the error
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
Rate limit exceeded message with retry guidance
Message describing the internal server error
Error code identifying the type of server error
Paginated group list
{
"webdomain-groups": [
{
"webdomain_group_id": "623",
"webdomain_group_name": "Social Media Sites"
},
{
"webdomain_group_id": "619",
"webdomain_group_name": "Sports"
}
],
"paging": {
"previous": "<server-url>/bsp/api/v1/bmp/webdomain-groups?skip-token=NTA6LTQ4OjI6MTc3NTQwODQ4MjQxMA%3D%3D"
}
}
Empty result
{
"webdomain-groups": []
}
Limit exceeded
{
"errorCode": "ARRAY_SIZE_OUT_OF_RANGE",
"url": "/bsp/api/v1/bmp/webdomain-groups",
"errorMsg": "Range limit exceeded. Maximum allowed: 1000"
}
Unauthorized
{
"errorCode": "UNAUTHORIZED",
"errorMsg": "You are not authorized to perform this action"
}
Insufficient permissions
{
"errorCode": "FORBIDDEN",
"errorMsg": "You do not have permission to access this resource"
}
Rate limit exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
Server error
{
"error_description": "Internal Server error, Please try again in a moment.",
"error_code": "COM0004"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.