List devices

POST

/devices

Query and filter devices

Relations:

employee (Person): The person who owns the device

Additional Filters:

employee_organization (string): Filter by employee's organization/team

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Successful operation

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location '/devices' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "distinct_count": "string",
    "distinct_on": "host_name",
    "include_total_count": true,
    "limit": 10,
    "offset": 0,
    "query": "name='\''WINPC-4291'\'' AND status IN ('\''active'\'', '\''pending'\'')",
    "sort": "name desc, id"
}'

Response Example

200 - Example 1

{
    "distinct_values": [
        {
            "count": 0,
            "value": null
        }
    ],
    "pagination": {
        "count": 0,
        "total_count": 1000
    },
    "items": [
        {
            "activation_lock": "unspecified",
            "active_usb_connections": {
                "composite_count": 0,
                "hid_count": 2,
                "kvm_count": 0,
                "max_usb_risk_level": 1,
                "network_adapter_count": 0,
                "storage_count": 1,
                "unknown_count": 0
            },
            "antivirus": "unspecified",
            "apps_installed": 47,
            "disk_encryption": "unspecified",
            "employee_email": "joe.smith@example.com",
            "employee_name": "Joe Smith",
            "id": "8CA67511-744C-4D74-B26E-7281CF88712F",
            "last_seen": "2021-01-01T00:00:00Z",
            "last_usb_usage": "2021-01-01T00:00:00Z",
            "local_user_accounts": [
                {
                    "admin": true,
                    "name": "John Doe",
                    "user_id": "S-1-5-21-1234567890-1234567890-1234567890-1001",
                    "username": "john.doe"
                }
            ],
            "mac_addresses": [
                "00:1B:44:11:3A:B7"
            ],
            "mdm": "unspecified",
            "model": "MacBook Pro",
            "name": "Joe's Mac",
            "platform": "windows",
            "risk_factors": [
                {
                    "magnitude": 40,
                    "type": "sensitive_file"
                }
            ],
            "risk_score": 9.2,
            "serial_number": "C02X1234DC79",
            "sources": [
                "unspecified"
            ]
        }
    ]
}

Modified at 2026-07-28 15:47:54

Get document by id

Get a device