Method: partners.vendors.customers.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the customers of the vendor.
HTTP request
GET https://androiddeviceprovisioning.googleapis.com/v1/{parent=partners/*/vendors/*}/customers
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The resource name in the format partners/[PARTNER_ID]/vendors/[VENDOR_ID].
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of results to be 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 to list customers of the vendor.
| JSON representation |
{
"customers": [
{
object (Company)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Fields |
customers[] |
object (Company)
List of customers of the vendor.
|
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 vendor using a \u003ccode\u003eGET\u003c/code\u003e request to the provided URL, which employs gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e path parameter specifying the vendor's resource name, and supports optional query parameters \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, as this endpoint is only used to fetch data and not change it.\u003c/p\u003e\n"],["\u003cp\u003eThe successful response contains a JSON body with a list of customers, an optional \u003ccode\u003enextPageToken\u003c/code\u003e for retrieving subsequent pages, and a \u003ccode\u003etotalSize\u003c/code\u003e indicating the total number of customers, regardless of pagination.\u003c/p\u003e\n"],["\u003cp\u003eAccessing this endpoint requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkprovisioning\u003c/code\u003e.\u003c/p\u003e\n"]]],["This document details how to list a vendor's customers via an HTTP GET request to `https://androiddeviceprovisioning.googleapis.com/v1/{parent}/customers`. The `parent` path parameter, formatted as `partners/*/vendors/*`, is required. Optional query parameters `pageSize` and `pageToken` manage pagination. The request body is empty. A successful response includes a list of customers in JSON format, alongside `nextPageToken` for pagination and `totalSize`. Authorization requires the `androidworkprovisioning` OAuth scope.\n"],null,["# Method: partners.vendors.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.ListVendorCustomersResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nLists the customers of the vendor.\n\n### HTTP request\n\n`GET https://androiddeviceprovisioning.googleapis.com/v1/{parent=partners/*/vendors/*}/customers`\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 resource name in the format `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of results to be 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 to list customers of the vendor.\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 of the vendor. |\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)."]]