Mobiledevices: list

Retrieves a paginated list of all mobile devices for an account. Try it now.


HTTP request



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 100, inclusive. (Default: 100)
orderBy string Device property to use for sorting results.

Acceptable values are:
  • "deviceId": The serial number for a Google Sync mobile device. For Android devices, this is a software generated unique identifier.
  • "email": The device owner's email address.
  • "lastSync": Last policy settings sync date time of the device.
  • "model": The mobile device's model.
  • "name": The device owner's user name.
  • "os": The device's operating system.
  • "status": The device status.
  • "type": Type of the device.
pageToken string Token to specify next page in the list
projection string Restrict information returned to a set of selected fields.

Acceptable values are:
  • "BASIC": Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
  • "FULL": Includes all metadata fields
query string Search string in the format provided by List query operators.
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.


This request requires authorization with at least one of the following scopes:


For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.


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

  "kind": "admin#directory#mobiledevices",
  "etag": etag,
  "mobiledevices": [
    mobiledevices Resource
  "nextPageToken": string
Property name Value Description Notes
kind string The type of the API resource. For Mobiledevices resources, the value is admin#directory#mobiledevices.
mobiledevices[] list List of Mobile Device objects.
nextPageToken string Token used to access next page of this result.
etag etag ETag of the resource.

Try it!

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