REST Resource: people

{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}

object (Source)

The sources of data for the person.

string

Output only. Any former resource names this person has had. Populated only for people.connections.list requests that include a sync token.

The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

string

Output only. Resource names of people linked to this resource.

boolean

Output only. True if the person resource has been deleted. Populated only for people.connections.list and otherContacts.list sync requests.

enum (ObjectType)

Output only. DEPRECATED (Please use person.metadata.sources.profileMetadata.objectType instead)

The type of the person object.

{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}

enum (SourceType)

The source type.

string

The unique identifier within the source type generated by the server.

string

Only populated in person.metadata.sources.

The HTTP entity tag of the source. Used for web cache validation.

string (Timestamp format)

Output only. Only populated in person.metadata.sources.

Last update timestamp of this source.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

object (ProfileMetadata)

Output only. Only populated in person.metadata.sources.

Metadata about a source of type PROFILE.

{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}

enum (ObjectType)

Output only. The profile object type.

enum (UserType)

Output only. The user types.

{
  "metadata": {
    object (FieldMetadata)
  },
  "formattedValue": string,
  "type": string,
  "formattedType": string,
  "poBox": string,
  "streetAddress": string,
  "extendedAddress": string,
  "city": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "countryCode": string
}

object (FieldMetadata)

Metadata about the address.

string

The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

string

The type of the address. The type can be custom or one of these predefined values:

• home
• work
• other

string

Output only. The type of the address translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

string

The P.O. box of the address.

string

The street address.

string

The extended address of the address; for example, the apartment number.

string

The city of the address.

string

The region of the address; for example, the state or province.

string

The postal code of the address.

string

The country of the address.

string

The ISO 3166-1 alpha-2 country code of the address.

{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}

boolean

Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with primary set to true.

boolean

True if the field is the primary field for the source. Each source must have at most one field with sourcePrimary set to true.

boolean

Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

object (Source)

The source of the field.

{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}

object (FieldMetadata)

Metadata about the age range.

enum (AgeRange)

The age range.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}

object (FieldMetadata)

Metadata about the biography.

string

The short biography.

enum (ContentType)

The content type of the biography.

{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}

object (FieldMetadata)

Metadata about the birthday.

object (Date)

The date of the birthday.

string

A free-form string representing the user's birthday.

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}

object (FieldMetadata)

Metadata about the bragging rights.

string

The bragging rights; for example, climbed mount everest.

{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

Metadata about the calendar URL.

string

The calendar URL.

string

The type of the calendar URL. The type can be custom or one of these predefined values:

• home
• freeBusy
• work

string

Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}

object (FieldMetadata)

Metadata about the client data.

string

The client specified key of the client data.

string

The client specified value of the client data.

{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}

object (FieldMetadata)

Metadata about the cover photo.

string

The URL of the cover photo.

boolean

True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}

object (FieldMetadata)

Metadata about the email address.

string

The email address.

string

The type of the email address. The type can be custom or one of these predefined values:

• home
• work
• other

string

Output only. The type of the email address translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

string

The display name of the email.

{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

Metadata about the event.

object (Date)

The date of the event.

string

The type of the event. The type can be custom or one of these predefined values:

• anniversary
• other

string

Output only. The type of the event translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

Metadata about the external ID.

string

The value of the external ID.

string

The type of the external ID. The type can be custom or one of these predefined values:

• account
• customer
• loginId
• network
• organization

string

Output only. The type of the event translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}

object (FieldMetadata)

Metadata about the file-as.

string

The file-as value

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}

object (FieldMetadata)

Metadata about the gender.

string

The gender for the person. The gender can be custom or one of these predefined values:

• male
• female
• unspecified

string

Output only. The value of the gender translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale. Unspecified or custom value are not localized.

string

Free form text field for pronouns that should be used to address the person. Common values are:

• he/him
• she/her
• they/them

{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}

object (FieldMetadata)

Metadata about the IM client.

string

The user name used in the IM client.

string

The type of the IM client. The type can be custom or one of these predefined values:

• home
• work
• other

string

Output only. The type of the IM client translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

string

The protocol of the IM client. The protocol can be custom or one of these predefined values:

• aim
• msn
• yahoo
• skype
• qq
• googleTalk
• icq
• jabber
• netMeeting

string

Output only. The protocol of the IM client formatted in the viewer's account locale or the Accept-Language HTTP header locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}

object (FieldMetadata)

Metadata about the interest.

string

The interest; for example, stargazing.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}

object (FieldMetadata)

Metadata about the locale.

string

The well-formed IETF BCP 47 language tag representing the locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "current": boolean,
  "buildingId": string,
  "floor": string,
  "floorSection": string,
  "deskCode": string
}

object (FieldMetadata)

Metadata about the location.

string

The free-form value of the location.

string

The type of the location. The type can be custom or one of these predefined values:

• desk
• grewUp

boolean

Whether the location is the current location.

string

The building identifier.

string

The floor name or number.

string

The floor section in floor_name.

string

The individual desk location.

{
  "metadata": {
    object (FieldMetadata)
  },

  // Union field membership can be only one of the following:
  "contactGroupMembership": {
    object (ContactGroupMembership)
  },
  "domainMembership": {
    object (DomainMembership)
  }
  // End of list of possible types for union field membership.
}

object (FieldMetadata)

Metadata about the membership.

object (ContactGroupMembership)

The contact group membership.

object (DomainMembership)

Output only. The domain membership.

{
  "contactGroupId": string,
  "contactGroupResourceName": string
}

string

Output only. The contact group ID for the contact group membership.

string

The resource name for the contact group, assigned by the server. An ASCII string, in the form of contactGroups/{contactGroupId}. Only contactGroupResourceName can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

{
  "inViewerDomain": boolean
}

boolean

True if the person is in the viewer's Google Workspace domain.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}

object (FieldMetadata)

Metadata about the miscellaneous keyword.

string

The value of the miscellaneous keyword.

enum (KeywordType)

The miscellaneous keyword type.

string

Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "displayName": string,
  "displayNameLastFirst": string,
  "unstructuredName": string,
  "familyName": string,
  "givenName": string,
  "middleName": string,
  "honorificPrefix": string,
  "honorificSuffix": string,
  "phoneticFullName": string,
  "phoneticFamilyName": string,
  "phoneticGivenName": string,
  "phoneticMiddleName": string,
  "phoneticHonorificPrefix": string,
  "phoneticHonorificSuffix": string
}

object (FieldMetadata)

Metadata about the name.

string

Output only. The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.

string

Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.

string

The free form name value.

string

The family name.

string

The given name.

string

The middle name(s).

string

The honorific prefixes, such as Mrs. or Dr.

string

The honorific suffixes, such as Jr.

string

The full name spelled as it sounds.

string

The family name spelled as it sounds.

string

The given name spelled as it sounds.

string

The middle name(s) spelled as they sound.

string

The honorific prefixes spelled as they sound.

string

The honorific suffixes spelled as they sound.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}

object (FieldMetadata)

Metadata about the nickname.

string

The nickname.

enum (NicknameType)

The type of the nickname.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}

object (FieldMetadata)

Metadata about the occupation.

string

The occupation; for example, carpenter.

{
  "metadata": {
    object (FieldMetadata)
  },
  "type": string,
  "formattedType": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "current": boolean,
  "name": string,
  "phoneticName": string,
  "department": string,
  "title": string,
  "jobDescription": string,
  "symbol": string,
  "domain": string,
  "location": string,
  "costCenter": string,
  "fullTimeEquivalentMillipercent": integer
}

object (FieldMetadata)

Metadata about the organization.

string

The type of the organization. The type can be custom or one of these predefined values:

• work
• school

string

Output only. The type of the organization translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

object (Date)

The start date when the person joined the organization.

object (Date)

The end date when the person left the organization.

boolean

True if the organization is the person's current organization; false if the organization is a past organization.

string

The name of the organization.

string

The phonetic name of the organization.

string

The person's department at the organization.

string

The person's job title at the organization.

string

The person's job description at the organization.

string

The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

string

The domain name associated with the organization; for example, google.com.

string

The location of the organization office the person works at.

string

The person's cost center at the organization.

integer

The person's full-time equivalent millipercent within the organization (100000 = 100%).

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

Metadata about the phone number.

string

The phone number.

string

Output only. The canonicalized ITU-T E.164 form of the phone number.

string

The type of the phone number. The type can be custom or one of these predefined values:

• home
• work
• mobile
• homeFax
• workFax
• otherFax
• pager
• workMobile
• workPager
• main
• googleVoice
• other

string

Output only. The type of the phone number translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}

object (FieldMetadata)

Metadata about the photo.

string

The URL of the photo. You can change the desired size by appending a query parameter sz={size} at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

boolean

True if the photo is a default photo; false if the photo is a user-provided photo.

{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

Metadata about the relation.

string

The name of the other person this relation refers to.

string

The person's relation to the other person. The type can be custom or one of these predefined values:

• spouse
• child
• mother
• father
• parent
• brother
• sister
• friend
• relative
• domesticPartner
• manager
• assistant
• referredBy
• partner

string

Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}

object (FieldMetadata)

Metadata about the relationship interest.

string

The kind of relationship the person is looking for. The value can be custom or one of these predefined values:

• friend
• date
• relationship
• networking

string

Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}

object (FieldMetadata)

Metadata about the relationship status.

string

The relationship status. The value can be custom or one of these predefined values:

• single
• inARelationship
• engaged
• married
• itsComplicated
• openRelationship
• widowed
• inDomesticPartnership
• inCivilUnion

string

Output only. The value of the relationship status translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}

object (FieldMetadata)

Metadata about the residence.

string

The address of the residence.

boolean

True if the residence is the person's current residence; false if the residence is a past residence.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

Metadata about the SIP address.

string

The SIP address in the RFC 3261 19.1 SIP URI format.

string

The type of the SIP address. The type can be custom or or one of these predefined values:

• home
• work
• mobile
• other

string

Output only. The type of the SIP address translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}

object (FieldMetadata)

Metadata about the skill.

string

The skill; for example, underwater basket weaving.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}

object (FieldMetadata)

Metadata about the tagline.

string

The tagline.

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

Metadata about the URL.

string

The URL.

string

The type of the URL. The type can be custom or one of these predefined values:

• home
• work
• blog
• profile
• homePage
• ftp
• reservations
• appInstallPage: website for a Currents application.
• other

string

Output only. The type of the URL translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}

object (FieldMetadata)

Metadata about the user defined data.

string

The end user specified key of the user defined data.

string

The end user specified value of the user defined data.