# Retrieve list of configured webdomain groups

Retrieves all configured webdomain groups.

## Endpoint

`GET /bsp/api/v1/bmp/webdomain-groups`

## Request

### Request URL

`https://`[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)`/bsp/api/v1/bmp/webdomain-groups`

### Scope

`DesktopCentralCloud.BrowserManager.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** `string` — Mandatory: `application/json`

#### Query Parameters

- **search** `string` — Optional. Search string to filter webdomain groups by name (contains match). Example: 'corporate', 'social-media'
- **limit** `integer` — Optional. Max results per page. Example: 50, 100, 200
- **offset** `integer` — Optional. Starting index for results (0-based). Example: 0, 50, 100
- **skip-token** `string` — Optional. Cursor-based pagination token returned from previous response for fetching next page

### Sample Request

```curl
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/webdomain-groups \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP 200

Response body: `application/json`

- `JSON Object`
  - **webdomain-groups** `JSON Array` — Webdomain group summaries. Empty when no groups match the search criteria

### HTTP 400

Response body: `application/json`

- `JSON Object`
  - **errorCode** `string` — Error code indicating a query parameter value is out of the allowed range
  - **errorMsg** `string` — Message describing which parameter exceeded the allowed range
  - **url** `string` — The request URL that triggered the error

### HTTP 401

Response body: `application/json`

- `JSON Object`
  - **errorCode** `long` — Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
  - **errorMsg** `string` — Authentication failure reason

### HTTP 403

Response body: `application/json`

- `JSON Object`
  - **errorCode** `long` — Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
  - **errorMsg** `string` — Message indicating insufficient privileges to access this resource

### HTTP 429

Response body: `application/json`

- `JSON Object`
  - **errorCode** `long` — 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
  - **errorMsg** `string` — Rate limit exceeded message with retry guidance

### HTTP 500

Response body: `application/json`

- `JSON Object`
  - **error_description** `string` — Message describing the internal server error
  - **error_code** `string` — Error code identifying the type of server error

## Sample Responses

### HTTP 200

#### Paginated group list

```json
{
  "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

```json
{
  "webdomain-groups": []
}
```

### HTTP 400

#### Limit exceeded

```json
{
  "errorCode": "ARRAY_SIZE_OUT_OF_RANGE",
  "url": "/bsp/api/v1/bmp/webdomain-groups",
  "errorMsg": "Range limit exceeded. Maximum allowed: 1000"
}
```

### HTTP 401

#### Unauthorized

```json
{
  "errorCode": "UNAUTHORIZED",
  "errorMsg": "You are not authorized to perform this action"
}
```

### HTTP 403

#### Insufficient permissions

```json
{
  "errorCode": "FORBIDDEN",
  "errorMsg": "You do not have permission to access this resource"
}
```

### HTTP 429

#### Rate limit exceeded

```json
{
  "errorCode": "RATE_LIMIT_EXCEEDED",
  "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
```

### HTTP 500

#### Server error

```json
{
  "error_description": "Internal Server error, Please try again in a moment.",
  "error_code": "COM0004"
}
```

## Rate Limit

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.