User Record Fields
| Field | Read-Only | Description |
| id | Y | the primaryEmail of the user to be updated (exclude on create) |
| primaryEmail (required for creation) | N | The User's primary email address |
| password (required for create) | N | Stores the password for the user account |
| hashFunctionName | N | when setting a password, the hash function that has already been applied to the password. Legal values are “SHA-1”, “MD5”, and “CRYPT” or leave unspecified if password in clear text |
| givenName (required for create) | N | the User's first name |
| familyName (required for create) | N | the User's last name |
| fullName | Y | the User's full name |
| admin | N | indicates if the User has super administrator privileges |
| suspended | N | indicates if the User is suspended |
| suspensionReason | Y | indicates the reason the User was suspended: “ADMIN”, “UNDER13”, “WEB_LOGIN_REQUIRED”, “ABUSE” |
| changePasswordAtNextLogin | N | indicates if the User is forced to change their password at the next login |
| ipWhitelisted | N | indicates if the User's IP address is whitelisted |
| includeInGlobalAddressList | N | indicates if the User's profile is visible in the G-Suite global address list when the contact sharing feature is enabled for the domain |
| ims | N | the User's User IM Record Fields |
| emails | N | the User's User Email Record Fields |
| externalIds | N | the User's User External ID Record Fields |
| relations | N | the User's User Relationship Record Fields |
| addresses | N | the User's User Address Record Fields |
| organizations | N | the User's User Organization Record Fields |
| phones | N | the User's User Phone Number Record Fields |
| etag | Y | eTag of the resource |
| isDelegatedAdmin | Y | Indicates if the User is a delegated administrator |
| lastLoginTime | Y | the last time the User logged into the User's account (Date object) |
| creationTime | Y | the time the User User's account was created (Date object) |
| deletionTime | Y | the time the User User's account was deleted (Date object) |
| customerId | Y | the customer ID of the User |
| isMailboxSetup | Y | indicates if the user's Google mailbox is created |
| thumbnailPhotoUrl | Y | photo Url of the user |
| uniqueid | Y | the unique ID for the user |
| aliases | Y | the User's alias email addresses |
| nonEditableAliases | Y | the user's non-editable alias email addresses - typically outside the account's primary domain or sub-domain |
| memberOf | Y | all groups for which a user or group has a membership |
| customSchemas | N | the User's Custom Schema Record Fields |
| userName | N | the user name of the User (DEPRECATED - use primaryEmail) |
| user.emailLists | Y | list of Groups the User belongs to (DEPRECATED - use memberOf) |
| user.nicknames | Y | the Nicknames of the User (DEPRECATED - use aliases) |
Group Record Fields
| Field | Read-Only | Description |
| id | Y | the id of the Group to be updated (exclude on create) |
| groupId (required for creating) | N | the email address of the Group |
| groupName (required for creating) | N | the name of the Group |
| description | Y | the description of the Group |
| member | Y | list of members of the Group |
| etag | Y | eTag of the resource |
| whoCanAdd | N | the members that can add members to the Group. Can be set to all members, managers, or none |
| whoCanJoin | N | the members that can join the Group. Can be set to members in any domain, by request, or invitation |
| whoCanViewGroup | N | the members that can view the Group. Can be set to members in the domain, managers, members, or anyone |
| whoCanLeaveGroup | N | the members that can leave the Group. Can be set to all members, managers, or none |
| whoCanContactOwner | N | the members that can contact the Group owner. can be set to all in the domain, members, managers, or anyone |
Alias Record Fields
| Field | Read-Only | Description |
| id | Y | the id of the Alias (exclude on create) |
| alias | Y | the Alias email address |
| primaryEmail | Y | The aliased User's/Group's primary email address |
| etag | Y | eTag of the resource |
OrgUnit Record Fields
| Field | Read-Only | Description |
| id | Y | the id of the OrgUnit (exclude on create) |
| name | N | the simple name of the OrgUnit |
| parentOrgUnitPath | N | the full path name of the OrgUnit parent |
| description | N | the description of the OrgUnit |
| blockInheritance | N | block policy inheritance from OrgUnits higher in the OrgUnit tree (“true”/“false”) |
| orgUnitPath | Y | the full pathname of the OrgUnit |
| etag | Y | eTag of the resource |
Shared Contact Record Fields
| Field | Read-Only | Description |
| id | Y | the id of the Contact (exclude on create) |
| namePrefix | N | An honorific prefix of the Contact, e.g. 'Mr' or 'Mrs' |
| givenName | N | given name of the Contact |
| additionalName | N | the additional name of the Contact, eg. middle name |
| familyName | N | the family name of the Contact |
| nameSuffix | N | Honorific suffix of the Contact, e.g. 'Jr' or 'MD' |
| fullName | N | Unstructured representation of the name of the Contact |
| content | N | notes about the Contact |
| N | Contact Email Record Fields | |
| im | N | Contact IM Record Fields |
| organization | N | Contact Organization Record Fields |
| phoneNumber | N | Contact Phone Number Record Fields |
| structuredPostalAddress | N | Contact Postal Address Record Fields |
| where | N | place associated with the Contact |
| extendedProperty | N | Contact Extended Property Record Fields |
| title | Y | the title of the Contact |
| updated | Y | the date the Contact record was last updated |
Calendar Resource Record Fields
| Field | Read-Only | Description |
| id | Y | the id of the Resource (exclude on create) |
| resourceId (required for creating) | N | the unique name of the Resource |
| resourceName | N | the name of the Resource |
| resourceDescription | N | the description of the Resource |
| resourceEmail | Y | the email address of the Resource (and the id of the associated Calendar) |
| resourceType | N | the type of the Resource |
| resourceCommonName | N | the display name of the Resource (DEPRECATED - use resourceName) |
User Send-As Alias Record Fields
| Field | Read-Only | Description |
| userId | N | the id of the User the Send-As Alias will apply to |
| name | N | the name associated with the Send-As Alias |
| address | N | the email address of the Send-As Alias |
| replyTo | N | optional reply-to address of Send-As Alias |
| makeDefault | N | the make the Send-As Alias the default for the User |
| isDefault | Y | indicates whether or not the Send-As Alias is currently the default for the User |
| verified | Y | indicates if the ownership of the email address's domain has been verified. This field must be true (verified) before the Send-As alias address can work. |
Custom Schema Definition Record Fields
| Field | Read-Only | Description |
| id | Y | The id of the schema |
| schemaName | N | The name of the custom schema |
| schemaId | Y | The unique identifier of the schema |
| fields | N | 1 or more Custom Field Definition Records |
Custom Field Definition Record Fields
| Field | Read-Only | Description |
| fieldName | N | The name of the custom field |
| fieldId | Y | The unique identifier of the field |
| fieldType | N | The type of the field:
|
| indexed | N | true if the field is to be indexed (default: true) |
| multiValued | N | true if the field is multivalued (default: false) |
| readAccessType | N | Who can view the values of this field:
|
| numericIndexingSpec | N | Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting this field allows a range of queries to be supported. |
| numericIndexingSpec.maxValue | N | The maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but the search may not be as performant. |
| numericIndexingSpec.maxValue | N | The minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but the search may not be as performant. |
Contact Email Record Fields
| Field | Description |
| address (required) | the email address |
| displayName | the display name of the entity the email address belongs to |
| label | name for the email address, e.g. Work, Personal, Preferred, etc. |
| rel | the type of email: one of home, work, or other |
| primary | boolean indicating this is the primary email address |
Contact IM Record Fields
| Field | Description |
| address (required) | the instant messaging address |
| label | name for the email address, e.g. Work, Personal, Preferred, etc. |
| rel | the type of IM: one of home, NetMeeting, work, or other |
| protocol | the IM protocol: one of AIM, MSN, YAHOO, SKYPE, QQ, GOOGLE_TALK, ICQ, JABBER |
| primary | boolean indicating this is the primary im address |
Contact Organization Record Fields
| Field | Description |
| orgDepartment | the department within the organization |
| orgName | the name of the organization |
| orgSymbol | the symbol of the organization |
| orgTitle | the title of the person of the organization |
| orgJobDescription | the job description of the person within the organization |
| label | label for the organization, e.g. Work, Volunteer, etc. |
| rel | the type of organization: one of work, or other |
| primary | boolean indicating this is the primary organization for the person |
| where | a place associated with the organization, e.g. office location |
Contact Phone Number Record Fields
| Field | Description |
| number (required) | the phone number |
| label | name for the phone number, e.g. Work, Personal, Preferred, etc. |
| rel | the type of phone number: one of assistant, callback, car, company_main, fax, home, home_fax, isdn, main, mobile, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager, other_fax, or other |
| uri | URI of phone number for VOIP access |
| primary | boolean indicating this is the primary phone number |
Contact Postal Address Record Fields
| Field | Description |
| street | the street address |
| pobox | the post office box |
| neighborhood | the neighborhood |
| city | the city |
| region | state, province, etc |
| postcode | postal code |
| country | name of the country |
| countryCode | country code |
| formattedAddress | the full, unstructured postal address |
| label | name of the address, e.g. Work, Personal, Preferred, etc. |
| rel | the type of address: one of work, home, or other |
| primary | boolean indicating this is the primary phone number |
Contact Extended Property Record Fields
| Field | Description |
| name | the name of the extended property |
| realm | the realm of the extended property |
| value | the value of the extended property |
User Email Record Fields
| Field | Description |
| address | the email address |
| primary | indicates if this is the user's primary email |
| type | the type of the email account: “home”, “work”, “other”, “custom” |
| customType | if the value of type is custom, this field contains the custom type string |
User IM Record Fields
| Field | Description |
| im | the user's IM network ID |
| primary | indicates this is the user's primary IM |
| protocol | the IM protocol: “aim”, “gtalk”, “icq”, “jabber”, “msn”, “net_meeting”, “qq”, “skype”, “yahoo”, “custom_protocol” |
| customProtocol | if the protocol value is custom_protocol, this field holds the custom protocol's string |
| type | the type of the IM account: “home”, “work”, “other”, “custom” |
| customType | if the IM type is custom, this field holds the custom type string |
User Organization Record Fields
| Field | Description |
| costCenter | the cost center of the organization |
| department | the department within the organization |
| description | the description of the organization |
| domain | the domain the organization belongs to |
| location | the physical location of the organization |
| name | the name of the organization |
| primary | indicates if this is the user's primary organization |
| symbol | text string symbol of the organization |
| title | the user's title within the organization |
| type | the type of organization: “unknown”, “school”, “work”, “domain_only”, “custom” |
| customType | if the value of type is custom, this field contains the custom type |
User Phone Number Record Fields
| Field | Description |
| value | a human-readable phone number |
| primary | indicates if this is the user's primary phone number |
| type | the type of phone number: “assistant”, “callback”, “car”, “company_main”, “grand_central”, “home”, “home_fax”, “isdn”, “main”, “mobile”, “other”, “other_fax”, “pager”, “radio”, “telex”, “tty_tdd”, “work”, “work_fax”, “work_mobile”, “work_pager”, “custom” |
| customType | if the value of type is custom, this field contains the custom type |
User Address Record Fields
| Field | Description |
| country | the country |
| countryCode | the country code |
| extendedAddress | for extended addresses, such as an address that includes a sub-region |
| formatted | a full and unstructured postal address |
| locality | the town or city of the address |
| poBox | the post office box |
| postalCode | the ZIP or postal code |
| primary | indicates if this is the user's primary address |
| region | the abbreviated province or state |
| sourceIsStructured | indicates if the user-supplied address was formatted |
| streetAddress | the street address |
| type | the address type: “home”, “other”, “work”, “custom” |
| customType | if the address type is custom, this field contains the custom value |
User External ID Record Fields
| Field | Description |
| value | the value of the ID |
| type | the type of the ID. Allowed values are: “account”, “custom”, “customer”, “network”, “organization” |
| customType | if the external ID type is custom, this field holds the custom type |
User Relationship Record Fields
| Field | Description |
| value | the name of the person the user is related to |
| type | the type of relation: “assistant”, “brother”, “child”, “domestic_partner”, “father”, “friend”, “manager”, “mother”, “parent”, “partner”, “referred_by”, “relative”, “sister”, “spouse”, “custom” |
| customType | if the value of type is custom, this field contains the custom type |
User Custom Schema Record Fields
| Field | Description |
| <schema_name> | A record containing the custom schema fields for the schema with the name schema_name |
| <schema_name>.<field_name> | For single-valued fields, the value of the field For multi-valued fields, 0 or more User Custom Schema Multivalued Value Record |
User Custom Schema Multivalued Value Record Fields
| Field | Description |
| value | The value of the field item |
| type | Optional type of the value
|
| customType | The name of the custom type if type=custom |