Retrieves all configured webdomains.
get /bsp/api/v1/bmp/webdomains
https://{serverurl}/bsp/api/v1/bmp/webdomains
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Filter by webdomain type category. Example: 'allowed', 'blocked'
Search string to filter webdomains by URL or name (contains match). Example: 'google.com', 'social'
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://appdomains/bsp/api/v1/bmp/webdomains \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Paginated webdomain list response with standard webdomain entries
Pagination metadata
URL for the next page of results, if available
URL for the previous page of results, if available
Webdomain entries
Webdomain item in list response
Unique identifier of the webdomain
Name of the webdomain
Display URL of the webdomain
Bad request error when limit exceeds maximum allowed value
Error code indicating the limit parameter exceeds the allowed maximum
Message indicating the allowed range was exceeded
Request URL that triggered the error
Unauthorized error code: credentials missing, expired, or invalid
Authentication failure reason
Error code indicating insufficient permissions
Message indicating insufficient privileges to access this resource
Rate limit error code returned when the API call reached threshold
Rate limit exceeded message with retry guidance
Internal server error when listing webdomains
Message describing the server-side failure
Internal server error code
All webdomains
{
"webdomains": [
{
"webdomain_name": "localhost",
"webdomain_id": "3",
"url": "localhost"
},
{
"webdomain_name": "mail.google.com",
"webdomain_id": "21",
"url": "mail.google.com"
},
{
"webdomain_name": "www.abc.com",
"webdomain_id": "10",
"url": "www.abc.com"
},
{
"webdomain_name": "www.youtube.com",
"webdomain_id": "7",
"url": "www.youtube.com"
}
]
}
Page with previous link
{
"webdomains": [
{
"webdomain_name": "www.bbc.com",
"webdomain_id": "17",
"url": "www.bbc.com"
},
{
"webdomain_name": "www.xyz.com",
"webdomain_id": "13",
"url": "www.xyz.com"
},
{
"webdomain_name": "www.youtube.com",
"webdomain_id": "7",
"url": "www.youtube.com"
}
],
"paging": {
"previous": "<server-url>/bsp/api/v1/bmp/webdomains?skip-token=NTA6LTQ2OjI6MTc3NTU4MzA2NTE1Mg%3D%3D"
}
}
Webdomains with plugin count
{
"webdomains": [
{
"webdomain_name": "flash-site.com",
"webdomain_id": "15",
"plugin_count": 5,
"url": "flash-site.com"
}
]
}
Limit exceeded
{
"errorCode": "ARRAY_SIZE_OUT_OF_RANGE",
"url": "/bsp/api/v1/bmp/webdomains",
"errorMsg": "Range limit exceeded. Maximum allowed: 1000"
}
Unauthorized
{
"errorCode": "UNAUTHORIZED",
"errorMsg": "You are not authorized to perform this action"
}
Forbidden
{
"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: 120 | 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.