List

Lists the user's customer accounts

2 variables
8 variables

Lists the user's customer accounts

Input

This building block consumes 2 input parameters

  = Parameter name
  = Format

pageToken STRING

A token specifying which result page to return

pageSize INTEGER

The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive)

Output

This building block provides 8 output parameters

  = Parameter name
  = Format

customers[] OBJECT

A reseller, vendor, or customer in the zero-touch reseller and customer APIs

customers[].name STRING

Output only. The API resource name of the company. The resource name is one of the following formats:

  • partners/[PARTNER_ID]/customers/[CUSTOMER_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]

Assigned by the server

customers[].adminEmails[] STRING

customers[].termsStatus ENUMERATION

Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus

customers[].ownerEmails[] STRING

customers[].companyName STRING

Required. The name of the company. For example XYZ Corp. Displayed to the company's employees in the zero-touch enrollment portal

customers[].companyId INTEGER

Output only. The ID of the company. Assigned by the server

nextPageToken STRING

A token used to access the next page of results. Omitted if no further results are available