listCustomers
Stay organized with collections
Save and categorize content based on your preferences.
A company (referred to as a customer)
represents a unique organization with a zero-touch account. This method lists
customers associated with your reseller account.
Method signature
public ListCustomersResponse listCustomers(ListCustomersRequest request) throws CommonException;
ListCustomersRequest
| Property name |
Value |
Required |
Description |
pageSize |
int |
No |
The page size, up to 100. If greater than 100 or null, 100 is used. |
pageToken |
string |
No |
The page token. If empty, the first page is returned. |
vendorParams |
map |
No |
Extra fields, vendor specified key-value pair. |
ListCustomersResponse
| Property name |
Value |
Description |
customers |
List of object(Company) |
The list of customers associated with the reseller. |
totalCount |
int |
The total count of devices matching the request. |
nextPageToken |
strong |
The next page token. Empty for the last page. |
vendorParams |
map |
Extra fields, vendor specified key-value pair. |
Error behavior
If an error occurs, the library throws a CommonException containing one of the
following error codes:
| Error code |
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |
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 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eA company, referred to as a customer, represents an organization with a zero-touch account.\u003c/p\u003e\n"],["\u003cp\u003eThis method \u003ccode\u003elistCustomers\u003c/code\u003e is used to list customers associated with a reseller account.\u003c/p\u003e\n"],["\u003cp\u003eThe request for the list of customers can be customized using \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003evendorParams\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListCustomersResponse\u003c/code\u003e provides a list of customers, total customer count, the next page token, and extra vendor parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003elistCustomers\u003c/code\u003e method can throw a \u003ccode\u003eCommonException\u003c/code\u003e with \u003ccode\u003eINTERNAL_SERVER_ERROR\u003c/code\u003e or \u003ccode\u003eINVALID_PAGE_TOKEN\u003c/code\u003e error codes.\u003c/p\u003e\n"]]],["The `listCustomers` method retrieves a list of customer organizations associated with a reseller account. It accepts a `ListCustomersRequest` with optional `pageSize` (up to 100), `pageToken`, and `vendorParams`. The response, `ListCustomersResponse`, includes a list of `customers`, `totalCount`, `nextPageToken` for pagination, and `vendorParams`. Errors are returned as `CommonException` with codes like `INTERNAL_SERVER_ERROR` or `INVALID_PAGE_TOKEN`.\n"],null,["# listCustomers\n\nA [`company`](/zero-touch/reseller-library/reference/objects#company) (referred to as a *customer*)\nrepresents a unique organization with a zero-touch account. This method lists\ncustomers associated with your reseller account.\n\nMethod signature\n----------------\n\n public ListCustomersResponse listCustomers(ListCustomersRequest request) throws CommonException;\n\nListCustomersRequest\n--------------------\n\n| Property name | Value | Required | Description |\n|----------------|----------|----------|-----------------------------------------------------------------------------|\n| `pageSize` | `int` | No | The page size, up to `100`. If greater than `100` or `null`, `100` is used. |\n| `pageToken` | `string` | No | The page token. If empty, the first page is returned. |\n| `vendorParams` | `map` | No | Extra fields, vendor specified key-value pair. |\n\nListCustomersResponse\n---------------------\n\n| Property name | Value | Description |\n|-----------------|-----------------------------------------------------------------------------------------|-----------------------------------------------------|\n| `customers` | List of `object(`[`Company`](/zero-touch/reseller-library/reference/objects#company)`)` | The list of customers associated with the reseller. |\n| `totalCount` | `int` | The total count of devices matching the request. |\n| `nextPageToken` | `strong` | The next page token. Empty for the last page. |\n| `vendorParams` | `map` | Extra fields, vendor specified key-value pair. |\n\nError behavior\n--------------\n\nIf an error occurs, the library throws a `CommonException` containing one of the\nfollowing error codes:\n\n| Error code |\n|-------------------------|\n| `INTERNAL_SERVER_ERROR` |\n| `INVALID_PAGE_TOKEN` |"]]