Retrieves all configured webdomain groups.
get /bsp/api/v1/bmp/webdomain-groups
https://{server-hostname}:8383/bsp/api/v1/bmp/webdomain-groups Copied!
Authorization: d92d4xxxxxxxxxxxxx15f52
Search string to filter webdomain groups by name (contains match). Example: 'corporate', 'social-media'
Max results per page. Example: 50, 100, 200
Starting index for results (0-based). Example: 0, 50, 100
Cursor-based pagination token returned from previous response for fetching next page
curl --request GET \
--url 'https://appdomain/bsp/api/v1/bmp/webdomain-groups?search=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE' \
--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
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: API key or OAuth token missing, expired or invalid
Authentication failure reason
Forbidden error code: the user lacks the required MDM_OSUpdateMgmt UEM role
Message indicating insufficient privileges
Rate limit error code: API call threshold exceeded for this endpoint group
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.