# 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://{server-hostname}:8383/bsp/api/v1/bmp/devices`

### Scope

`BrowserManager.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** (`string`, mandatory): `application/json`

### Sample Request

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

## Response Parameters

### HTTP code 200

**Response Body:** `application/json`

- `JSON Object`: List of devices with agent details
  - **devices** (`JSON Array`): Device details with agent information

#### Sample Response: 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 code 400

**Response Body:** `application/json`

- `JSON Object`: Bad request error when pagination parameters exceed the allowed range
  - **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

#### Sample Response: HTTP 400

**Pagination exceeded**

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

### HTTP code 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

#### Sample Response: HTTP 401

**Unauthorized**

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

### HTTP code 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

#### Sample Response: HTTP 403

**Forbidden**

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

### HTTP code 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

#### Sample Response: 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 code 500

**Response Body:** `application/json`

- `JSON Object`: Internal server error during device operations
  - **error_description** (`string`): Message describing the server-side failure
  - **error_code** (`string`): Internal server error code

#### Sample Response: HTTP 500

**Server error**

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

### Possible Response Codes

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

## Rate Limiting

![](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.