Chromeosdevices: list

Requires authorization

Retrieves a paginated list of Chrome OS devices within an account. Try it now.

Request

HTTP request

GET https://www.googleapis.com/admin/directory/v1/customer/customerId/devices/chromeos

Parameters

Parameter name Value Description
Path parameters
customerId string The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
Optional query parameters
maxResults integer Maximum number of results to return. Acceptable values are 1 to 200, inclusive. (Default: 100)
orderBy string Device property to use for sorting results.

Acceptable values are:
  • "annotatedLocation": Chrome device location as annotated by the administrator.
  • "annotatedUser": Chrome device user as annotated by the administrator.
  • "lastSync": The date and time the Chrome device was last synchronized with the policy settings in the Admin console.
  • "notes": Chrome device notes as annotated by the administrator.
  • "serialNumber": The Chrome device serial number entered when the device was enabled.
  • "status": Chrome device status. For more information, see the chromeosdevices resource.
  • "supportEndDate": Chrome device support end date. This is applicable only for devices purchased directly from Google.
orgUnitPath string The full path of the organizational unit or its unique ID.
pageToken string The pageToken query parameter is used to request the next page of query results. The follow-on request's pageToken query parameter is the nextPageToken from your previous response.
projection string Restrict information returned to a set of selected fields.

Acceptable values are:
  • "BASIC": Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
  • "FULL": Includes all metadata fields
query string Search string in the format given at View device information and organizational units.
sortOrder string Whether to return results in ascending or descending order. Must be used with the orderBy parameter.

Acceptable values are:
  • "ASCENDING": Ascending order.
  • "DESCENDING": Descending order.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
https://www.googleapis.com/auth/admin.directory.device.chromeos

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "admin#directory#chromeosdevices",
  "etag": etag,
  "chromeosdevices": [
    chromeosdevices Resource
  ],
  "nextPageToken": string
}
Property name Value Description Notes
kind string The type of the API resource. For Chrome OS devices, the value is admin#directory#chromeosdevices.
chromeosdevices[] list List of Chrome OS Device objects.
nextPageToken string Token used to access the next page of this result. To access the next page, use this token's value in the pageToken query string of this request.
etag etag ETag of the resource.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.