# Retrieve a paginated list of all EDR-managed devices

Returns a paginated list of all EDR-managed devices with their component status, agent version, OS details, isolation status, and last contact time. Supports filtering by device status, domain, name, resource ID, OS type, scan status, IP address, and agent version.

## Endpoint

`GET /edr/api/view/devices`

## Request

### Request URL

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

### Scope

`DesktopCentralCloud.EDR.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

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

#### Query Parameters

- **status** (`string`, Optional): Filter devices by EDR agent status.
  - `0` - Not enabled
  - `1` - Active
  - `8` - Inactive
  - `11` - Quarantined
- **domain** (`string`, Optional): Filter devices by domain name (exact match, e.g., `'TEST GROUP'`).
- **deviceName** (`string`, Optional): Filter devices by device hostname (partial match supported, e.g., `'test-001'`).
- **resourceId** (`long`, Optional): Filter by the unique resource ID of a specific device, e.g., `'12345'`.
- **operatingSystems** (`string`, Optional): Filter devices by OS name (partial match supported, e.g., `'Windows 11'`).
- **scanStatus** (`string`, Optional): Filter by scan status.
  - `0` - In Progress
  - `1` - Completed
  - `2` - Stopped
  - `3` - Paused
  - `4` - Failed
  - `5` - Cancelled
- **ipAddress** (`string`, Optional): Filter devices by IP address (exact match, e.g., `'192.168.1.1'`).
- **agentVersion** (`string`, Optional): Filter devices by agent version string (partial match supported, e.g., `'1.0.66.0'`).
- **agentVersionStatus** (`string`, Optional): Filter devices by agent version status.
  - `0` - Yet To Contact
  - `1` - Latest Version
  - `2` - Oldest Version
- **page** (`string`, Optional): Page number for pagination. Defaults to `1`.
- **pageLimit** (`string`, Optional): Number of records per page. Default is `25`, maximum is `1000`.

### Sample Request

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

## Response Parameters

### HTTP Code 200

Response body: `application/json`

- JSON Object
  - **status** (`string`): Response status. `'success'` if the request completed successfully, `'failure'` if an error occurred.
  - **totalRecords** (`string`): Total number of records matching the applied filters.
  - **totalPages** (`string`): Total number of pages available based on the current page limit.
  - **metadata** (`JSON Object`): Pagination metadata containing the current page number and page limit.
  - **Links** (`JSON Object`): Navigation links to the next and previous pages of results.
  - **messageResponse** (`JSON Object`): Actual device item response.

### HTTP Code 400

Response body: `application/json`

- JSON Object
  - **errorCode** (`string`): `EDRCOMMON001` — Internal server error occurred while retrieving the EDR device list.
  - **errorMessage** (`string`): General internal error message.

### HTTP Code 429

Response body: `application/json`

- JSON Object
  - **errorCode** (`string`): Rate limit error code.
    - `IAM0019` — Returned when the API call threshold is exceeded within the allowed duration window.
  - **errorMessage** (`string`): Rate limit exceeded message with guidance on when to retry.

### Possible Response Codes

- `200` HTTP code
- `400` HTTP code
- `429` HTTP code

### Sample Response: HTTP 200

Paginated list of EDR-managed devices

```json
{
  "metadata": {
    "limit": 25,
    "page": 3
  },
  "totalRecords": "51",
  "messageResponse": [
    {
      "resource_name_transform": "DESKTOP-EXAMPLE",
      "managed_status": "61",
      "processor_architecture": "2",
      "agent_last_contact_time": "1700000100000",
      "activated_time": "1700000000000",
      "is_suspended": "false",
      "ml_version": "",
      "def_file_version": "260101120000",
      "isolation_status": null,
      "ip_address_transform": "192.168.1.10,10.0.0.5",
      "os_name_transform": "Windows 11 Professional Edition (x64)",
      "server_os": "1",
      "remarks_transform": "Protection Enabled",
      "udid": "2000000000000001",
      "domain_netbios_name_transform": "CORP",
      "yara_sign_version": "",
      "status_update_time": "1700003600000",
      "bloom_version": "",
      "health_last_contact_time_transform": "Jan 15, 2025 10:29 AM",
      "component_id": "3000000000000001",
      "scan_end_time_transform": "--",
      "os_version": "10.0.19041",
      "os_platform": "1",
      "last_successful_scan_time_transform": "--",
      "component_status_transform": "1",
      "device_alerts_count_transform": "10",
      "agent_version": "11.x.xxxx.xx.W",
      "clips_version": "",
      "latest_alert_detection_time_transform": "Jan 15, 2025 10:30 AM",
      "mc_engine_version": "",
      "edr_status_update_time": "1700000360000",
      "resource_id": "2000000000000001",
      "scan_status_transform": "--",
      "error_code": null,
      "customer_name": "John Doe",
      "customer_id": "1000000000000001",
      "component_version_transform": "1.0.x.0"
    }
  ],
  "totalPages": 3,
  "Links": {
    "next": "null",
    "prev": "/edr/api/view/devices?page=2&pageLimit=25"
  },
  "status": "success"
}
```

### Sample Response: HTTP 400

Unexpected server-side error

```json
{
  "errorMessage": "Exception while retrieving EDR device list",
  "errorCode": "EDRCOMMON001"
}
```

### Sample Response: HTTP 429

API call threshold exceeded

```json
{
  "errorCode": "IAM0019",
  "url": "/edr/api/view/devices",
  "errorMsg": "The URL /edr/api/view/devices was called too many times. Please retry after a while."
}
```

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

**Duration:** 1 minute | **Threshold:** 30 | **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.