Read User

Retrieve details of a user in Google Workspace.

Input

Field Definition Type Required

Read By

User ID

Unique identifier of the user.

Text

TRUE

Output

Field Definition Type

User

ID Unique identifier of the user.

Text

ETag ETag of the resource.

Text

First Name User's first name.

Text

Last Name User's last name.

Text

Full Name User's full name.

Text

Gender
Address Me As Pronouns of the user. For example, they/them/their.

Text

Type Type of gender. Acceptable values are: female, male, other, and unknown.

Text

Custom Gender Name of a custom gender.

Text

Notes
Content Type Content type of the note. Acceptable values are: text_plain and text_html. Default is text_plain.

Text

Value Content of the note.

Text

Is Admin? Indicator if the user has super administrator privileges (this field can only be edited in the Make a User an Administrator action).

True/False

Is Delegated Admin? Indicator if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console.

True/False

Change Password At Next Login? Indicator if the user is forced to change their password at next login (does not apply when SSO is configured with a third party identity provider).

True/False

Agreed to Terms? Indicator if the user has completed an initial login and accepted the Terms of Service agreement.

True/False

IP Allow Listed? Indicator if the user's IP address is allow listed.

True/False

Suspended? Indicator if the user is suspended.

True/False

Suspension Reason Reason that the user is suspended by either the administrator or by Google at the time of suspension; options are ABUSE, ADMIN, UNDER13, or WEB_LOGIN_REQUIRED.

Text

Last Login Time Last time the user signed in to the account. Date
Creation Time Time the user account was created. Date
Deletion Time Time the user account was deleted. Date
Organization Unit Path

Full path to the organizational associated with the user.

A user's organizational unit determines to which Google Workspace services the user has access. If the user is moved to a new organization, the user's access changes.

The full path requires a leading slash (/).

For example, for an organization unit named sales_support under /corp/sales, the full organization unit path is /sales/sales_support. The organization key, corp is not required.

Note

You can't remove a user from an organizational unit. This field only allows you to change the organizational unit to which a user belongs.

Text

Customer ID Customer ID to retrieve all account users.

Text

Is Enrolled in 2SV? Indicates if user enrolled in 2-step verification.

True/False

Is Enforced in 2SV? Indicates if user is 2-step verification enforced.

True/False

Is Mailbox Setup? Indicates if the user's Google mailbox is created.

True/False

Included in Global Address List? Indicates whether the user profile is visible in the Google Workspace global address list. Contact sharing feature must be enabled for the domain.

True/False

Aliases Alias email addresses.

List of Text

Is Archived? Indicates whether a user profile is archived.

True/False

Recovery Email Recovery email of the user.

Text

Recovery Phone Recovery phone of the user.

Text

Keywords
Type Type of keyword. Acceptable values are: custom, mission, occupation, and outlook.

Text

Custom Type Custom type for keyword. Required if type is custom.

Text

Value Keyword.

Text

IMs

IM Network ID User's IM accounts (user may have multiple IM accounts but only one primary).

Text

Type IM account type:
  • home
  • work
  • custom
  • other

Text

Custom Type Required, user defined value if IM type is custom.

Text

Protocol IM network (custom network or standard network).

Text

Custom Protocol Required, user defined value if the protocol is custom.

Text

Primary? Indicates whether this is the user's primary IM.

True/False

Emails

Email Address Email address of the user.

Text

Type
  • home
  • work
  • custom
  • other

Dropdown

Custom Type Required, user defined value if email address type selection is custom.

Text

Primary? Indicates whether this is the user's primary email address.

True/False

External IDs

External ID Value of the ID.

Text

Type Type of external ID:
  • account
  • custom
  • customer
  • login_ID
  • network
  • organization

Text

Custom Type Required, user defined value if address type selection is custom.

Text

Relations

Relation Name Name of the person the user is related to.

Text

Type Type of relation:
  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse

Text

Custom Type Required, user defined value if type is custom.

Text

Locations
Area Textual location. For example, San Francisco, CA or near New York.

Text

Building ID Identifier of the building.

Text

Desk Code Textual code of individual desk location.

Text

Floor Name Floor name or number.

Text

Floor Section Section of the floor. For example, East or West.

Text

Type Type of the location. Acceptable values: custom, default, and desk.

Text

Custom Type Custom type of the location. Required if type is custom.

Text

Addresses

Street Street portion of the user's address.

Text

PO Box User's post office box.

Text

City User's city of residence.

Text

Region User's geographic region.

Text

Country User's country of residence.

Text

Country Code Telephone prefix for user's country of residence (ISO 3166-1 standard).

Text

Extended Address Extended fields for addresses that includes a sub-region.

Text

Formatted Address Formatted version of the address.

Text

Type
  • home
  • work
  • custom
  • other

Dropdown

Custom Type Required, user defined value if address type selection is custom.

Text

Primary? Indicates whether this is the user's primary address.

True/False

Organizations

Organization Name Name of the organization.

Text

Description Description of the organization.

Text

Department Department in the organization that the user is associated with (for example, sales or engineering).

Text

Job Title User's title in the organization (for example, member or engineer).

Text

Location Physical location of the organization (this is not required to be an address).

Text

Symbol Text string symbol of the organization (for example, Google's symbol is GOOG).

Text

Cost Center Cost center of the user's organization.

Text

Domain Domain that the organization belongs to.

Text

Type Type of organization.

Text

Custom Type Required, user defined value if address type selection is custom.

Text

Primary? Indicates whether this is the user's primary organization.

True/False

Phones

Phone Number Human-readable phone number (any telephone number format).

Text

Type Type of phone number:
  • assistant
  • callback
  • car
  • company_main
  • custom
  • grand_central
  • home
  • home_fax
  • isdn
  • main
  • mobile
  • other
  • other_fax
  • pager
  • radio
  • telex
  • tty_ttd
  • work
  • work_fax
  • work_mobile
  • work_pager

Text

Custom Type Required, user defined value if the type is custom.

Text

Primary? Indicates whether this is the user's primary phone number.

True/False

Websites

Website URL URL of the website.

Text

Type Type or purpose of the website:
  • app_install_page
  • blog
  • custom
  • ftp
  • home
  • home_page
  • other
  • profile
  • reservations
  • resume
  • work

Text

Custom Type Required, user defined value if website type is custom.

Text

Primary? Indicator if this is the user's primary website.

True/False

Custom Fields All fields from a custom schema for a user.

Text

Related topics

Google Workspace Admin connector

Workflow elements

Google Workspace API documentation