Method: partners.vendors.customers.list

  • This endpoint retrieves a list of customers associated with a specific vendor using a GET request to the provided URL, which employs gRPC Transcoding syntax.

  • The request requires a parent path parameter specifying the vendor's resource name, and supports optional query parameters pageSize and pageToken for pagination.

  • The request body must be empty, as this endpoint is only used to fetch data and not change it.

  • The successful response contains a JSON body with a list of customers, an optional nextPageToken for retrieving subsequent pages, and a totalSize indicating the total number of customers, regardless of pagination.

  • Accessing this endpoint requires the OAuth scope https://www.googleapis.com/auth/androidworkprovisioning.

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.