Method: customers.devices.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists a customer's devices.
HTTP request
GET https://androiddeviceprovisioning.googleapis.com/v1/{parent=customers/*}/devices
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The customer managing the devices. An API resource name in the format customers/[CUSTOMER_ID].
|
Query parameters
| Parameters |
pageSize |
string (int64 format)
Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
|
pageToken |
string
A token specifying which result page to return.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message of customer's liting devices.
| JSON representation |
{
"devices": [
{
object (Device)
}
],
"nextPageToken": string
} |
| Fields |
devices[] |
object (Device)
The customer's devices.
|
nextPageToken |
string
A token used to access the next page of results. Omitted if no further results are available.
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidworkzerotouchemm
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-04 UTC.
[null,null,["Last updated 2024-12-04 UTC."],[[["\u003cp\u003eThis webpage details how to list a customer's devices using the Android Device Provisioning API.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a \u003ccode\u003eGET\u003c/code\u003e method to retrieve devices via a URL formatted with gRPC Transcoding, specifying the customer ID in the path.\u003c/p\u003e\n"],["\u003cp\u003eIt requires the inclusion of \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters to manage result pagination, with \u003ccode\u003epageSize\u003c/code\u003e determining the maximum number of devices per page.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty and the response body contains a list of devices and a \u003ccode\u003enextPageToken\u003c/code\u003e to obtain additional pages of results if available.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this API endpoint requires authorization using the \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkzerotouchemm\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This API endpoint retrieves a list of a customer's devices using a `GET` request. The URL specifies the customer via the `parent` path parameter (`customers/[CUSTOMER_ID]`). Results are paginated using `pageSize` (1-100) and `pageToken` query parameters. The request body is empty. The successful response contains a list of `devices` and, if more exist, a `nextPageToken` for subsequent pages. Authentication requires the `androidworkzerotouchemm` OAuth scope.\n"],null,["# Method: customers.devices.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListDevicesResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nLists a customer's devices.\n\n### HTTP request\n\n`GET https://androiddeviceprovisioning.googleapis.com/v1/{parent=customers/*}/devices`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. |\n| `pageToken` | `string` A token specifying which result page to return. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message of customer's liting devices.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"devices\": [ { object (/zero-touch/reference/customer/rest/v1/customers.devices#Device) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------|\n| `devices[]` | `object (`[Device](/zero-touch/reference/customer/rest/v1/customers.devices#Device)`)` The customer's devices. |\n| `nextPageToken` | `string` A token used to access the next page of results. Omitted if no further results are available. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidworkzerotouchemm`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]