Get

Retrieves a customer

1 variables
18 variables

Retrieves a customer

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage customer related information
  • View customer related information

Input

This building block consumes 1 input parameters

  = Parameter name
  = Format

customerKey STRING Required

Id of the customer to be retrieved

Output

This building block provides 18 output parameters

  = Parameter name
  = Format

alternateEmail STRING

The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain

kind STRING

Identifies the resource as a customer. Value: admin#directory#customer

etag STRING

ETag of the resource

id STRING

The unique ID for the customer's G Suite account. (Readonly)

postalAddress OBJECT

STEPLADDER: Generated unstable field number for field 'address_line2' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'address_line3' to avoid collision. (See http://go/stepladder-help#fieldNumber)

postalAddress.postalCode STRING

The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element

postalAddress.contactName STRING

The customer contact's name

postalAddress.addressLine1 STRING

A customer's physical address. The address can be composed of one to three lines

postalAddress.region STRING

Name of the region. An example of a region value is NY for the state of New York

postalAddress.organizationName STRING

The company or company division name

postalAddress.addressLine2 STRING

Address line 2 of the address

postalAddress.countryCode STRING

This is a required property. For countryCode information see the ISO 3166 country code elements

postalAddress.locality STRING

Name of the locality. An example of a locality value is the city of San Francisco

postalAddress.addressLine3 STRING

Address line 3 of the address

customerDomain STRING

The customer's primary domain name string. Do not include the www prefix when creating a new customer

customerCreationTime DATE_TIME

The customer's creation time (Readonly)

phoneNumber STRING

The customer's contact phone number in E.164 format

language STRING

The customer's ISO 639-2 language code. The default value is en-US