# List managed devices

Retrieves all managed devices along with their basic details and agent status.

## Endpoint

`GET /bsp/api/v1/bmp/devices`

## Request

### Request URL

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

### Scope

`DesktopCentralCloud.BrowserManager.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Headers

| Parameter | Type | Required | Value |
|---|---|---|---|
| Accept | string | Mandatory | `application/json` |

### Query Parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | Optional | Search string to filter devices by name, FQDN, or username (contains match). Example: 'laptop', 'user123' |
| uninstall | string | Optional | Filter by agent installation status (comma-separated for multiple). Example: 'true', 'false' |
| 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 |
| platform_type | string | Optional | Filter by OS platform type. Example: '1' (Windows), '2' (Mac) |

### Sample Request

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

## Response Parameters

### HTTP 200

Response body: `application/json`

**JSON Object:** List of devices with agent details.

| Attribute | Type | Description |
|---|---|---|
| devices | JSON Array | Device details with agent information |

### HTTP 400

Response body: `application/json`

**JSON Object:** Bad request error when pagination parameters exceed the allowed range.

| Attribute | Type | Description |
|---|---|---|
| errorCode | string | Error code indicating a pagination parameter exceeds the allowed range |
| errorMsg | string | Message indicating the parameter value is out of range |
| url | string | Request URL that triggered the error |

### HTTP 401

Response body: `application/json`

| Attribute | Type | Description |
|---|---|---|
| errorCode | long | Unauthorized error code: credentials missing, expired, or invalid |
| errorMsg | string | Authentication failure reason |

### HTTP 403

Response body: `application/json`

| Attribute | Type | Description |
|---|---|---|
| errorCode | long | Error code indicating insufficient permissions |
| errorMsg | string | Message indicating insufficient privileges to access this resource |

### HTTP 429

Response body: `application/json`

| Attribute | Type | Description |
|---|---|---|
| errorCode | long | Rate limit error code returned when the API call reached threshold |
| errorMsg | string | Rate limit exceeded message with retry guidance |

### HTTP 500

Response body: `application/json`

**JSON Object:** Internal server error during device operations.

| Attribute | Type | Description |
|---|---|---|
| error_description | string | Message describing the server-side failure |
| error_code | string | Internal server error code |

## Possible Response Codes

- `200`
- `400`
- `401`
- `403`
- `429`
- `500`

## Sample Responses

### HTTP 200

Device list:

```json
{
  "devices": [
    {
      "agent_version": "1.0.5",
      "agent_installed_time": 1704067200000,
      "device_id": 999,
      "platform_type": 1,
      "user_name": "john.doe",
      "agent_installed_type": 1,
      "os_version": "10.0.19041",
      "agent_status": 1,
      "os_name": "Windows 10 Enterprise",
      "fqdn_name": "desktop-abc123.corp.local"
    }
  ],
  "paging": {
    "next": "<server-url>/api/v1/bmp/devices?skip-token=eyJ0eXBlIjoib2Zmc2V0IiwidmFsdWUiOjUwfQ"
  }
}
```

Empty device list:

```json
{
  "devices": []
}
```

### HTTP 400

Pagination exceeded:

```json
{
  "errorCode": "COM0014",
  "url": "/bsp/api/v1/bmp/devices",
  "errorMsg": "ARRAY_SIZE_OUT_OF_RANGE"
}
```

### HTTP 401

Unauthorized:

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

### HTTP 403

Forbidden:

```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 Limits

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