Method: partners.customers.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the customers that are enrolled to the reseller identified by the partnerId argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.
HTTP request
GET https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/customers
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
partnerId |
string (int64 format)
Required. The ID of the reseller partner.
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of results to be returned. If not specified or 0, all the records are returned.
|
pageToken |
string
A token identifying a page of results returned by the server.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message of all customers related to this partner.
| JSON representation |
{
"customers": [
{
object (Company)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Fields |
customers[] |
object (Company)
List of customers related to this reseller partner.
|
nextPageToken |
string
A token to retrieve the next page of results. Omitted if no further results are available.
|
totalSize |
integer
The total count of items in the list irrespective of pagination.
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidworkprovisioning
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-08-07 UTC.
[null,null,["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eThis endpoint retrieves a list of customers associated with a specific reseller partner, identified by the \u003ccode\u003epartnerId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request is a \u003ccode\u003eGET\u003c/code\u003e operation using a predefined URL structure and does not require a request body.\u003c/p\u003e\n"],["\u003cp\u003ePagination is supported through the \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters, allowing for the retrieval of a subset of customers and the navigation through large datasets.\u003c/p\u003e\n"],["\u003cp\u003eThe response body, when successful, contains an array of customer objects, along with pagination details such as \u003ccode\u003enextPageToken\u003c/code\u003e and \u003ccode\u003etotalSize\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe access to this API requires the \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkprovisioning\u003c/code\u003e authorization scope.\u003c/p\u003e\n"]]],["This document outlines the process to retrieve a list of customers associated with a reseller partner. The key action is to use a `GET` request to the specified URL: `https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/customers`, substituting `{partnerId}` with the reseller's ID. Optional query parameters `pageSize` and `pageToken` control pagination. The response includes a JSON payload with `customers` array, `nextPageToken`, and `totalSize`. The request requires authorization with the `https://www.googleapis.com/auth/androidworkprovisioning` scope, and the request body must be empty.\n"],null,["# Method: partners.customers.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.ListCustomersResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nLists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.\n\n### HTTP request\n\n`GET https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/customers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the reseller partner. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of results to be returned. If not specified or 0, all the records are returned. |\n| `pageToken` | `string` A token identifying a page of results returned by the server. |\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 all customers related to this partner.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"customers\": [ { object (/zero-touch/reference/reseller/rest/v1/partners.customers#Company) } ], \"nextPageToken\": string, \"totalSize\": integer } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `customers[]` | `object (`[Company](/zero-touch/reference/reseller/rest/v1/partners.customers#Company)`)` List of customers related to this reseller partner. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Omitted if no further results are available. |\n| `totalSize` | `integer` The total count of items in the list irrespective of pagination. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidworkprovisioning`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]