Method: customers.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the user's customer accounts.
HTTP request
GET https://androiddeviceprovisioning.googleapis.com/v1/customers
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageSize |
integer
Required. The maximum number of customers to show in a page of results. A number 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 for listing my customers.
| JSON representation |
{
"customers": [
{
object (Company)
}
],
"nextPageToken": string
} |
| Fields |
customers[] |
object (Company)
The customer accounts the calling user is a member of.
|
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 endpoint retrieves a list of customer accounts associated with the authenticated user via a \u003ccode\u003eGET\u003c/code\u003e request to \u003ccode\u003ehttps://androiddeviceprovisioning.googleapis.com/v1/customers\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e as query parameters to manage the number of results per page and navigate through multiple pages of customer accounts.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty for this endpoint, meaning no data should be sent within the request body.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a list of customer objects in the \u003ccode\u003ecustomers\u003c/code\u003e field, and an optional \u003ccode\u003enextPageToken\u003c/code\u003e string to retrieve subsequent pages of results if available.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this request requires the \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkzerotouchemm\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document outlines the process for listing a user's customer accounts via an HTTP GET request to `https://androiddeviceprovisioning.googleapis.com/v1/customers`. Required query parameters include `pageSize` (1-100) and `pageToken` for pagination. The request body must be empty. A successful response returns a JSON structure containing an array of `customers` (Company objects) and a `nextPageToken` for subsequent pages. Authorization requires the `androidworkzerotouchemm` OAuth scope.\n"],null,["# Method: customers.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCustomersResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nLists the user's customer accounts.\n\n### HTTP request\n\n`GET https://androiddeviceprovisioning.googleapis.com/v1/customers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Required. The maximum number of customers to show in a page of results. A number 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 for listing my customers.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"customers\": [ { object (/zero-touch/reference/customer/rest/v1/customers#Company) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| `customers[]` | `object (`[Company](/zero-touch/reference/customer/rest/v1/customers#Company)`)` The customer accounts the calling user is a member of. |\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)."]]