Skip to main content

List Devices

Lists/Searches devices.

Basic Parameters​

ParameterDescription
CustomerResource name of the customer, in the format: customers/{customer}, where customer is the customer to whom the device belongs. If you're using this API for your own organization, use customers/my_customer. If you're using this API to manage another organization, use customers/{customer}, where customer is the customer to whom the device belongs.
FilterAdditional restrictions when fetching list of devices. For a list of search fields, refer to (Mobile device search)[https://developers.google.com/admin-sdk/directory/v1/search-operators] fields. Multiple search fields are separated by the space character.
ViewThe view to use for the List request.
VIEW_UNSPECIFIED - Default value. The value is unused. The returned results are the same as in the Devices tab in the Google Workspace Mobile & Endpoints UI.
COMPANY_INVENTORY - This view contains all devices imported by the company admin. Each device in the response contains all information specified by the company admin when importing the device (i.e. asset tags). This includes devices that may be unaassigned or assigned to users.
USER_ASSIGNED_DEVICES - This view contains all devices with at least one user registered on the device. Each device in the response contains all device information, except for asset tags.

Advanced Parameters​

ParameterDescription
Delegated User OverridePerform the action on behalf of another user, overriding the delegated user defined in the connection.

If not specified, the delegated user is the one provided in the connection.

Has no effect when using an OAuth connection.

NOTE: the connection details are not edited by this input.
Order ByOrder specification for devices in the response. Only one of the following field names may be used to specify the order: createTime, lastSyncTime, model, osVersion, deviceType and serialNumber. desc may be specified optionally to specify results to be sorted in descending order. Default order is ascending.
Page SizeThe maximum number of objects to return. The maximum value is 100; values above 100 will be coerced to 100.
Page TokenA page token, received from a previous devices.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided must match the call that provided the page token.

Example Output​

{
    "devices": [
        {
            "androidSpecificAttributes": {
                "enabledUnknownSources": false,
                "ownerProfileAccount": false,
                "ownershipPrivilege": "Ownership privileges on device.",
                "supportsWorkProfile": false
            },
            "assetTag": "Asset tag of the device.",
            "basebandVersion": "Output only. Baseband version of the device.",
            "bootloaderVersion": "Output only. Device bootloader version. Example: 0.6.7.",
            "brand": "Output only. Device brand. Example: Samsung.",
            "buildNumber": "Output only. Build number of the device.",
            "clientTypes": [
                "string"
            ],
            "compromisedState": "Output only. Represents whether the Device is compromised.",
            "createTime": "Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.",
            "deviceId": "Unique identifier for the device.",
            "deviceType": "Output only. Type of device.",
            "enabledDeveloperOptions": false,
            "enabledUsbDebugging": false,
            "encryptionState": "Output only. Device encryption state.",
            "endpointVerificationSpecificAttributes": {
                "certificateAttributes": [
                    {
                        "certificateTemplate": {
                            "id": "The template id of the template. Example: \"1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047\".",
                            "majorVersion": 0,
                            "minorVersion": 0
                        },
                        "fingerprint": "The encoded certificate fingerprint.",
                        "issuer": "The name of the issuer of this certificate.",
                        "serialNumber": "Serial number of the certificate, Example: \"123456789\".",
                        "subject": "The subject name of this certificate.",
                        "thumbprint": "The certificate thumbprint.",
                        "validationState": "Validation state of this certificate.",
                        "validityExpirationTime": "Certificate not valid at or after this timestamp.",
                        "validityStartTime": "Certificate not valid before this timestamp."
                    }
                ]
            },
            "hostname": "Host name of the device.",
            "imei": "Output only. IMEI number of device if GSM device; empty otherwise.",
            "kernelVersion": "Output only. Kernel version of the device.",
            "lastSyncTime": "Most recent time when device synced with this service.",
            "managementState": "Output only. Management state of the device",
            "manufacturer": "Output only. Device manufacturer. Example: Motorola.",
            "meid": "Output only. MEID number of device if CDMA device; empty otherwise.",
            "model": "Output only. Model name of device. Example: Pixel 3.",
            "name": "Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.",
            "networkOperator": "Output only. Mobile or network operator of device, if available.",
            "osVersion": "Output only. OS version of the device. Example: Android 8.1.0.",
            "otherAccounts": [
                "string"
            ],
            "ownerType": "Output only. Whether the device is owned by the company or an individual",
            "releaseVersion": "Output only. OS release version. Example: 6.0.",
            "securityPatchTime": "Output only. OS security patch update time on device.",
            "serialNumber": "Serial Number of device. Example: HT82V1A01076.",
            "wifiMacAddresses": [
                "string"
            ]
        }
    ],
    "nextPageToken": "Token to retrieve the next page of results. Empty if there are no more results."
}

Workflow Library Example​

List Devices with Google Workspace and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop