{"openapi":"3.1.0","info":{"title":"People API (AAuth Connect)","version":"v1","description":"Provides access to information about profiles and contacts.","x-discovery-revision":"20260930","x-upstream":"https://people.googleapis.com/"},"servers":[{"url":"https://contacts.connect.aauth.dev"}],"paths":{"/contact-groups":{"get":{"operationId":"list_contact_groups","x-google-operation":"people.contactGroups.list","summary":"List all contact groups owned by the authenticated user. Members of the contact groups are not populated.","description":"List all contact groups owned by the authenticated user. Members of the contact groups are not populated.","parameters":[{"name":"syncToken","in":"query","description":"Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.","required":false,"schema":{"type":"string"}},{"name":"groupFields","in":"query","description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","required":false,"schema":{"type":"string","format":"google-fieldmask"}},{"name":"pageToken","in":"query","description":"Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.","required":false,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactGroupsResponse"}}}}},"security":[{"upstreamOAuth":["https://www.googleapis.com/auth/contacts.readonly"]}]}},"/other-contacts/search":{"get":{"operationId":"search_other_contacts","x-google-operation":"people.otherContacts.search","summary":"Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's `names`, `emailAddresses`, and `phoneNumbers` fields that are from the OTHER_CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts","description":"Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's `names`, `emailAddresses`, and `phoneNumbers` fields that are from the OTHER_CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts","parameters":[{"name":"pageSize","in":"query","description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"readMask","in":"query","description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers","required":false,"schema":{"type":"string","format":"google-fieldmask"}},{"name":"query","in":"query","description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}}},"security":[{"upstreamOAuth":["https://www.googleapis.com/auth/contacts.other.readonly"]}]}},"/contacts/{peopleId}":{"get":{"operationId":"get_contact","x-google-operation":"people.people.get","summary":"Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.","description":"Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.","parameters":[{"name":"peopleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"sources","in":"query","description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"]}},"explode":true},{"name":"personFields","in":"query","description":"Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","required":false,"schema":{"type":"string","format":"google-fieldmask"}},{"name":"requestMask.includeField","in":"query","description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","required":false,"schema":{"type":"string","format":"google-fieldmask"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"security":[{"upstreamOAuth":["https://www.googleapis.com/auth/contacts.readonly"]}]},"patch":{"operationId":"update_contact","x-google-operation":"people.people.updateContact","summary":"Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `\"failedPrecondition\"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. If making sequential updates to the same person, the etag from the `updateContact` response should be used to avoid failures. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","description":"Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `\"failedPrecondition\"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. If making sequential updates to the same person, the etag from the `updateContact` response should be used to avoid failures. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"peopleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"sources","in":"query","description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"]}},"explode":true},{"name":"updatePersonFields","in":"query","description":"Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined","required":false,"schema":{"type":"string","format":"google-fieldmask"}},{"name":"personFields","in":"query","description":"Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","required":false,"schema":{"type":"string","format":"google-fieldmask"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"security":[{"upstreamOAuth":["https://www.googleapis.com/auth/contacts"]}],"x-aauth-access-mode":"auth-token"},"delete":{"operationId":"delete_contact","x-google-operation":"people.people.deleteContact","summary":"Delete a contact person. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","description":"Delete a contact person. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"peopleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"upstreamOAuth":["https://www.googleapis.com/auth/contacts"]}],"x-aauth-access-mode":"per-call"}},"/contacts/search":{"get":{"operationId":"search_contacts","x-google-operation":"people.people.searchContacts","summary":"Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts","description":"Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts","parameters":[{"name":"pageSize","in":"query","description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"query","in":"query","description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","required":false,"schema":{"type":"string"}},{"name":"sources","in":"query","description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"]}},"explode":true},{"name":"readMask","in":"query","description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","required":false,"schema":{"type":"string","format":"google-fieldmask"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}}},"security":[{"upstreamOAuth":["https://www.googleapis.com/auth/contacts.readonly"]}]}},"/contacts":{"post":{"operationId":"create_contact","x-google-operation":"people.people.createContact","summary":"Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","description":"Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"sources","in":"query","description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"]}},"explode":true},{"name":"personFields","in":"query","description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","required":false,"schema":{"type":"string","format":"google-fieldmask"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"security":[{"upstreamOAuth":["https://www.googleapis.com/auth/contacts"]}],"x-aauth-access-mode":"auth-token"},"get":{"operationId":"list_contacts","x-google-operation":"people.people.connections.list","summary":"Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an [google.rpc.ErrorInfo](https://cloud.google.com/apis/design/errors#error_info) with reason \"EXPIRED_SYNC_TOKEN\". In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's contacts that have changed](/people/v1/contacts#list_the_users_contacts_that_have_changed).","description":"Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an [google.rpc.ErrorInfo](https://cloud.google.com/apis/design/errors#error_info) with reason \"EXPIRED_SYNC_TOKEN\". In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's contacts that have changed](/people/v1/contacts#list_the_users_contacts_that_have_changed).","parameters":[{"name":"personFields","in":"query","description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","required":false,"schema":{"type":"string","format":"google-fieldmask"}},{"name":"pageToken","in":"query","description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.connections.list` must match the first call that provided the page token.","required":false,"schema":{"type":"string"}},{"name":"requestSyncToken","in":"query","description":"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.connections.list`.","required":false,"schema":{"type":"boolean"}},{"name":"requestMask.includeField","in":"query","description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","required":false,"schema":{"type":"string","format":"google-fieldmask"}},{"name":"pageSize","in":"query","description":"Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sources","in":"query","description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"]}},"explode":true},{"name":"sortOrder","in":"query","description":"Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.","required":false,"schema":{"type":"string","enum":["LAST_MODIFIED_ASCENDING","LAST_MODIFIED_DESCENDING","FIRST_NAME_ASCENDING","LAST_NAME_ASCENDING"]}},{"name":"syncToken","in":"query","description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.connections.list` must match the first call that provided the sync token. More details about sync behavior at `people.connections.list`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}}}},"security":[{"upstreamOAuth":["https://www.googleapis.com/auth/contacts.readonly"]}]}}},"components":{"schemas":{"Address":{"description":"A person's physical address. May be a P.O. box or street address. All fields are optional.","type":"object","properties":{"formattedValue":{"description":"The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.","type":"string"},"extendedAddress":{"description":"The extended address of the address; for example, the apartment number.","type":"string"},"city":{"description":"The city of the address.","type":"string"},"countryCode":{"type":"string","description":"The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address."},"formattedType":{"readOnly":true,"description":"Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","type":"string"},"type":{"type":"string","description":"The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`"},"postalCode":{"description":"The postal code of the address.","type":"string"},"region":{"type":"string","description":"The region of the address; for example, the state or province."},"country":{"description":"The country of the address.","type":"string"},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the address."},"streetAddress":{"type":"string","description":"The street address."},"poBox":{"description":"The P.O. box of the address.","type":"string"}}},"AgeRangeType":{"type":"object","description":"A person's age range.","properties":{"metadata":{"description":"Metadata about the age range.","$ref":"#/components/schemas/FieldMetadata"},"ageRange":{"type":"string","enum":["AGE_RANGE_UNSPECIFIED","LESS_THAN_EIGHTEEN","EIGHTEEN_TO_TWENTY","TWENTY_ONE_OR_OLDER"],"description":"The age range.","enumDescriptions":["Unspecified.","Younger than eighteen.","Between eighteen and twenty.","Twenty-one and older."]}}},"Biography":{"type":"object","description":"A person's short biography.","properties":{"value":{"description":"The short biography.","type":"string"},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the biography."},"contentType":{"description":"The content type of the biography.","type":"string","enum":["CONTENT_TYPE_UNSPECIFIED","TEXT_PLAIN","TEXT_HTML"],"enumDescriptions":["Unspecified.","Plain text.","HTML text."]}}},"Birthday":{"type":"object","description":"A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to. Clients should always set the `date` field when mutating birthdays.","properties":{"text":{"description":"Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.","deprecated":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the birthday."},"date":{"$ref":"#/components/schemas/Date","description":"The structured date of the birthday."}}},"BraggingRights":{"properties":{"value":{"description":"The bragging rights; for example, `climbed mount everest`.","type":"string"},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the bragging rights."}},"description":"**DEPRECATED**: No data will be returned A person's bragging rights.","type":"object","deprecated":true},"CalendarUrl":{"description":"A person's calendar URL.","properties":{"metadata":{"description":"Metadata about the calendar URL.","$ref":"#/components/schemas/FieldMetadata"},"formattedType":{"description":"Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","type":"string","readOnly":true},"url":{"description":"The calendar URL.","type":"string"},"type":{"type":"string","description":"The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`"}},"type":"object"},"ClientData":{"type":"object","properties":{"value":{"type":"string","description":"The client specified value of the client data."},"metadata":{"description":"Metadata about the client data.","$ref":"#/components/schemas/FieldMetadata"},"key":{"description":"The client specified key of the client data.","type":"string"}},"description":"Arbitrary client data that is populated by clients. Duplicate keys and values are allowed."},"ContactGroup":{"properties":{"formattedName":{"readOnly":true,"description":"Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.","type":"string"},"resourceName":{"type":"string","description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`."},"clientData":{"type":"array","items":{"$ref":"#/components/schemas/GroupClientData"},"description":"The group's client data."},"name":{"description":"The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.","type":"string"},"etag":{"description":"The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.","type":"string"},"memberResourceNames":{"items":{"type":"string"},"description":"Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.","type":"array","readOnly":true},"groupType":{"readOnly":true,"type":"string","enumDescriptions":["Unspecified.","User defined contact group.","System defined contact group."],"enum":["GROUP_TYPE_UNSPECIFIED","USER_CONTACT_GROUP","SYSTEM_CONTACT_GROUP"],"description":"Output only. The contact group type."},"metadata":{"readOnly":true,"$ref":"#/components/schemas/ContactGroupMetadata","description":"Output only. Metadata about the contact group."},"memberCount":{"readOnly":true,"type":"integer","description":"Output only. The total number of contacts in the group irrespective of max members in specified in the request.","format":"int32"}},"description":"A contact group.","type":"object"},"ContactGroupMembership":{"properties":{"contactGroupId":{"deprecated":true,"description":"Output only. The contact group ID for the contact group membership.","readOnly":true,"type":"string"},"contactGroupResourceName":{"description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name 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.","type":"string"}},"type":"object","description":"A Google contact group membership."},"ContactGroupMetadata":{"properties":{"updateTime":{"format":"google-datetime","readOnly":true,"type":"string","description":"Output only. The time the group was last updated."},"deleted":{"type":"boolean","readOnly":true,"description":"Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token."}},"type":"object","description":"The metadata about a contact group."},"CoverPhoto":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the cover photo."},"url":{"description":"The URL of the cover photo.","type":"string"},"default":{"type":"boolean","description":"True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo."}},"description":"A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about."},"Date":{"properties":{"year":{"type":"integer","format":"int32","description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year."},"day":{"description":"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.","format":"int32","type":"integer"},"month":{"type":"integer","description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32"}},"type":"object","description":"Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp"},"DomainMembership":{"type":"object","properties":{"inViewerDomain":{"description":"True if the person is in the viewer's Google Workspace domain.","type":"boolean"}},"description":"A Google Workspace Domain membership."},"EmailAddress":{"description":"A person's email address.","properties":{"displayName":{"type":"string","description":"The display name of the email."},"type":{"description":"The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`","type":"string"},"value":{"description":"The email address.","type":"string"},"formattedType":{"readOnly":true,"description":"Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","type":"string"},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the email address."}},"type":"object"},"Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object","properties":{}},"Event":{"properties":{"metadata":{"description":"Metadata about the event.","$ref":"#/components/schemas/FieldMetadata"},"date":{"description":"The date of the event.","$ref":"#/components/schemas/Date"},"type":{"description":"The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`","type":"string"},"formattedType":{"type":"string","description":"Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true}},"description":"An event related to the person.","type":"object"},"ExternalId":{"description":"An identifier from an external entity related to the person.","properties":{"value":{"description":"The value of the external ID.","type":"string"},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the external ID."},"formattedType":{"type":"string","readOnly":true,"description":"Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale."},"type":{"description":"The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`","type":"string"}},"type":"object"},"FieldMetadata":{"description":"Metadata about a field.","type":"object","properties":{"sourcePrimary":{"type":"boolean","description":"True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true."},"primary":{"type":"boolean","readOnly":true,"description":"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."},"verified":{"description":"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.","type":"boolean","readOnly":true},"source":{"description":"The source of the field.","$ref":"#/components/schemas/Source"}}},"FileAs":{"type":"object","properties":{"value":{"description":"The file-as value","type":"string"},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the file-as."}},"description":"The name that should be used to sort the person in a list."},"Gender":{"type":"object","description":"A person's gender.","properties":{"formattedValue":{"type":"string","description":"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.","readOnly":true},"value":{"type":"string","description":"The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`"},"addressMeAs":{"description":"Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`","type":"string"},"metadata":{"description":"Metadata about the gender.","$ref":"#/components/schemas/FieldMetadata"}}},"GroupClientData":{"description":"Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.","type":"object","properties":{"value":{"description":"The client specified value of the client data.","type":"string"},"key":{"type":"string","description":"The client specified key of the client data."}}},"ImClient":{"type":"object","description":"A person's instant messaging client.","properties":{"metadata":{"description":"Metadata about the IM client.","$ref":"#/components/schemas/FieldMetadata"},"formattedType":{"readOnly":true,"description":"Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","type":"string"},"username":{"description":"The user name used in the IM client.","type":"string"},"type":{"type":"string","description":"The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`"},"formattedProtocol":{"description":"Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"protocol":{"type":"string","description":"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`"}}},"Interest":{"type":"object","properties":{"value":{"type":"string","description":"The interest; for example, `stargazing`."},"metadata":{"description":"Metadata about the interest.","$ref":"#/components/schemas/FieldMetadata"}},"description":"One of the person's interests."},"ListConnectionsResponse":{"description":"The response to a request for the authenticated user's connections.","type":"object","properties":{"totalItems":{"type":"integer","format":"int32","description":"The total number of items in the list without pagination."},"nextPageToken":{"type":"string","description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."},"connections":{"items":{"$ref":"#/components/schemas/Person"},"description":"The list of people that the requestor is connected to.","type":"array"},"totalPeople":{"type":"integer","deprecated":true,"format":"int32","description":"**DEPRECATED** (Please use totalItems) The total number of people in the list without pagination."},"nextSyncToken":{"type":"string","description":"A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token. When the response is paginated, only the last page will contain `nextSyncToken`."}}},"ListContactGroupsResponse":{"type":"object","properties":{"nextPageToken":{"type":"string","description":"The token that can be used to retrieve the next page of results."},"nextSyncToken":{"type":"string","description":"The token that can be used to retrieve changes since the last request."},"totalItems":{"format":"int32","type":"integer","description":"The total number of items in the list without pagination."},"contactGroups":{"description":"The list of contact groups. Members of the contact groups are not populated.","items":{"$ref":"#/components/schemas/ContactGroup"},"type":"array"}},"description":"The response to a list contact groups request."},"Locale":{"description":"A person's locale preference.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the locale."},"value":{"description":"The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.","type":"string"}}},"Location":{"type":"object","description":"A person's location.","properties":{"value":{"description":"The free-form value of the location.","type":"string"},"buildingId":{"description":"The building identifier.","type":"string"},"floor":{"type":"string","description":"The floor name or number."},"deskCode":{"type":"string","description":"The individual desk location."},"type":{"description":"The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`","type":"string"},"current":{"type":"boolean","description":"Whether the location is the current location."},"metadata":{"description":"Metadata about the location.","$ref":"#/components/schemas/FieldMetadata"},"floorSection":{"description":"The floor section in `floor_name`.","type":"string"}}},"Membership":{"description":"A person's membership in a group. Only contact group memberships can be modified.","type":"object","properties":{"metadata":{"description":"Metadata about the membership.","$ref":"#/components/schemas/FieldMetadata"},"contactGroupMembership":{"description":"The contact group membership.","$ref":"#/components/schemas/ContactGroupMembership"},"domainMembership":{"description":"Output only. The domain membership.","$ref":"#/components/schemas/DomainMembership","readOnly":true}}},"MiscKeyword":{"properties":{"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the miscellaneous keyword."},"type":{"enumDescriptions":["Unspecified.","Outlook field for billing information.","Outlook field for directory server.","Outlook field for keyword.","Outlook field for mileage.","Outlook field for priority.","Outlook field for sensitivity.","Outlook field for subject.","Outlook field for user.","Home.","Work.","Other."],"description":"The miscellaneous keyword type.","type":"string","enum":["TYPE_UNSPECIFIED","OUTLOOK_BILLING_INFORMATION","OUTLOOK_DIRECTORY_SERVER","OUTLOOK_KEYWORD","OUTLOOK_MILEAGE","OUTLOOK_PRIORITY","OUTLOOK_SENSITIVITY","OUTLOOK_SUBJECT","OUTLOOK_USER","HOME","WORK","OTHER"]},"formattedType":{"description":"Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","type":"string","readOnly":true},"value":{"description":"The value of the miscellaneous keyword.","type":"string"}},"type":"object","description":"A person's miscellaneous keyword."},"Name":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the name."},"unstructuredName":{"type":"string","description":"The free form name value."},"honorificPrefix":{"description":"The honorific prefixes, such as `Mrs.` or `Dr.`","type":"string"},"middleName":{"description":"The middle name(s).","type":"string"},"phoneticFamilyName":{"type":"string","description":"The family name spelled as it sounds."},"honorificSuffix":{"type":"string","description":"The honorific suffixes, such as `Jr.`"},"displayName":{"type":"string","readOnly":true,"description":"Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header."},"phoneticMiddleName":{"description":"The middle name(s) spelled as they sound.","type":"string"},"displayNameLastFirst":{"readOnly":true,"description":"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.","type":"string"},"phoneticHonorificPrefix":{"description":"The honorific prefixes spelled as they sound.","type":"string"},"phoneticGivenName":{"description":"The given name spelled as it sounds.","type":"string"},"phoneticFullName":{"description":"The full name spelled as it sounds.","type":"string"},"phoneticHonorificSuffix":{"description":"The honorific suffixes spelled as they sound.","type":"string"},"familyName":{"description":"The family name.","type":"string"},"givenName":{"description":"The given name.","type":"string"}},"description":"A person's name. If the name is a mononym, the family name is empty."},"Nickname":{"description":"A person's nickname.","properties":{"value":{"description":"The nickname.","type":"string"},"type":{"enum":["DEFAULT","MAIDEN_NAME","INITIALS","GPLUS","OTHER_NAME","ALTERNATE_NAME","SHORT_NAME"],"description":"The type of the nickname.","enumDescriptions":["Generic nickname.","Maiden name or birth family name. Used when the person's family name has changed as a result of marriage.","Initials.","Google+ profile nickname.","A professional affiliation or other name; for example, `Dr. Smith.`","Alternate name person is known by.","A shorter version of the person's name."],"type":"string","enumDeprecated":[false,true,true,true,true,false,true]},"metadata":{"description":"Metadata about the nickname.","$ref":"#/components/schemas/FieldMetadata"}},"type":"object"},"Occupation":{"description":"A person's occupation.","properties":{"metadata":{"description":"Metadata about the occupation.","$ref":"#/components/schemas/FieldMetadata"},"value":{"type":"string","description":"The occupation; for example, `carpenter`."}},"type":"object"},"Organization":{"properties":{"metadata":{"description":"Metadata about the organization.","$ref":"#/components/schemas/FieldMetadata"},"startDate":{"description":"The start date when the person joined the organization.","$ref":"#/components/schemas/Date"},"domain":{"description":"The domain name associated with the organization; for example, `google.com`.","type":"string"},"phoneticName":{"description":"The phonetic name of the organization.","type":"string"},"title":{"description":"The person's job title at the organization.","type":"string"},"department":{"description":"The person's department at the organization.","type":"string"},"jobDescription":{"description":"The person's job description at the organization.","type":"string"},"fullTimeEquivalentMillipercent":{"format":"int32","type":"integer","description":"The person's full-time equivalent millipercent within the organization (100000 = 100%)."},"endDate":{"$ref":"#/components/schemas/Date","description":"The end date when the person left the organization."},"symbol":{"description":"The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.","type":"string"},"current":{"type":"boolean","description":"True if the organization is the person's current organization; false if the organization is a past organization."},"formattedType":{"type":"string","description":"Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true},"costCenter":{"description":"The person's cost center at the organization.","type":"string"},"location":{"description":"The location of the organization office the person works at.","type":"string"},"type":{"type":"string","description":"The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`"},"name":{"description":"The name of the organization.","type":"string"}},"type":"object","description":"A person's past or current organization. Overlapping date ranges are permitted."},"Person":{"description":"Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.","type":"object","properties":{"addresses":{"items":{"$ref":"#/components/schemas/Address"},"type":"array","description":"The person's street addresses."},"biographies":{"items":{"$ref":"#/components/schemas/Biography"},"description":"The person's biographies. This field is a singleton for contact sources.","type":"array"},"taglines":{"deprecated":true,"items":{"$ref":"#/components/schemas/Tagline"},"readOnly":true,"description":"Output only. **DEPRECATED**: No data will be returned The person's taglines.","type":"array"},"coverPhotos":{"readOnly":true,"type":"array","description":"Output only. The person's cover photos.","items":{"$ref":"#/components/schemas/CoverPhoto"}},"etag":{"type":"string","description":"The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation."},"urls":{"type":"array","description":"The person's associated URLs.","items":{"$ref":"#/components/schemas/Url"}},"miscKeywords":{"type":"array","description":"The person's miscellaneous keywords.","items":{"$ref":"#/components/schemas/MiscKeyword"}},"emailAddresses":{"items":{"$ref":"#/components/schemas/EmailAddress"},"type":"array","description":"The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople."},"occupations":{"items":{"$ref":"#/components/schemas/Occupation"},"description":"The person's occupations.","type":"array"},"residences":{"type":"array","items":{"$ref":"#/components/schemas/Residence"},"description":"**DEPRECATED**: (Please use `person.locations` instead) The person's residences.","deprecated":true},"imClients":{"type":"array","description":"The person's instant messaging clients.","items":{"$ref":"#/components/schemas/ImClient"}},"names":{"type":"array","items":{"$ref":"#/components/schemas/Name"},"description":"The person's names. This field is a singleton for contact sources."},"events":{"type":"array","description":"The person's events.","items":{"$ref":"#/components/schemas/Event"}},"skills":{"description":"The person's skills.","type":"array","items":{"$ref":"#/components/schemas/Skill"}},"braggingRights":{"deprecated":true,"type":"array","items":{"$ref":"#/components/schemas/BraggingRights"},"description":"**DEPRECATED**: No data will be returned The person's bragging rights."},"sipAddresses":{"items":{"$ref":"#/components/schemas/SipAddress"},"type":"array","description":"The person's SIP addresses."},"metadata":{"readOnly":true,"description":"Output only. Metadata about the person.","$ref":"#/components/schemas/PersonMetadata"},"clientData":{"description":"The person's client data.","type":"array","items":{"$ref":"#/components/schemas/ClientData"}},"birthdays":{"items":{"$ref":"#/components/schemas/Birthday"},"description":"The person's birthdays. This field is a singleton for contact sources.","type":"array"},"interests":{"description":"The person's interests.","items":{"$ref":"#/components/schemas/Interest"},"type":"array"},"relationshipStatuses":{"items":{"$ref":"#/components/schemas/RelationshipStatus"},"readOnly":true,"deprecated":true,"type":"array","description":"Output only. **DEPRECATED**: No data will be returned The person's relationship statuses."},"phoneNumbers":{"description":"The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.","items":{"$ref":"#/components/schemas/PhoneNumber"},"type":"array"},"externalIds":{"description":"The person's external IDs.","type":"array","items":{"$ref":"#/components/schemas/ExternalId"}},"genders":{"items":{"$ref":"#/components/schemas/Gender"},"description":"The person's genders. This field is a singleton for contact sources.","type":"array"},"ageRanges":{"items":{"$ref":"#/components/schemas/AgeRangeType"},"readOnly":true,"description":"Output only. The person's age ranges.","type":"array"},"photos":{"items":{"$ref":"#/components/schemas/Photo"},"description":"Output only. The person's photos.","readOnly":true,"type":"array"},"resourceName":{"description":"The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.","type":"string"},"relationshipInterests":{"items":{"$ref":"#/components/schemas/RelationshipInterest"},"deprecated":true,"description":"Output only. **DEPRECATED**: No data will be returned The person's relationship interests.","readOnly":true,"type":"array"},"fileAses":{"items":{"$ref":"#/components/schemas/FileAs"},"description":"The person's file-ases.","type":"array"},"organizations":{"description":"The person's past or current organizations.","items":{"$ref":"#/components/schemas/Organization"},"type":"array"},"locales":{"type":"array","items":{"$ref":"#/components/schemas/Locale"},"description":"The person's locale preferences."},"userDefined":{"description":"The person's user defined data.","type":"array","items":{"$ref":"#/components/schemas/UserDefined"}},"calendarUrls":{"description":"The person's calendar URLs.","items":{"$ref":"#/components/schemas/CalendarUrl"},"type":"array"},"nicknames":{"items":{"$ref":"#/components/schemas/Nickname"},"type":"array","description":"The person's nicknames."},"ageRange":{"description":"Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.","deprecated":true,"enum":["AGE_RANGE_UNSPECIFIED","LESS_THAN_EIGHTEEN","EIGHTEEN_TO_TWENTY","TWENTY_ONE_OR_OLDER"],"enumDescriptions":["Unspecified.","Younger than eighteen.","Between eighteen and twenty.","Twenty-one and older."],"type":"string","readOnly":true},"memberships":{"items":{"$ref":"#/components/schemas/Membership"},"type":"array","description":"The person's group memberships."},"locations":{"items":{"$ref":"#/components/schemas/Location"},"type":"array","description":"The person's locations."},"relations":{"type":"array","items":{"$ref":"#/components/schemas/Relation"},"description":"The person's relations."}}},"PersonMetadata":{"description":"The metadata about a person.","properties":{"previousResourceNames":{"description":"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.","type":"array","readOnly":true,"items":{"type":"string"}},"deleted":{"description":"Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.","readOnly":true,"type":"boolean"},"linkedPeopleResourceNames":{"readOnly":true,"description":"Output only. Resource names of people linked to this resource.","items":{"type":"string"},"type":"array"},"objectType":{"enum":["OBJECT_TYPE_UNSPECIFIED","PERSON","PAGE"],"readOnly":true,"description":"Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.","enumDescriptions":["Unspecified.","Person.","[Currents Page.](https://workspace.google.com/products/currents/)"],"type":"string","deprecated":true},"sources":{"type":"array","description":"The sources of data for the person.","items":{"$ref":"#/components/schemas/Source"}}},"type":"object"},"PhoneNumber":{"properties":{"formattedType":{"readOnly":true,"type":"string","description":"Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale."},"value":{"type":"string","description":"The phone number."},"type":{"type":"string","description":"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`"},"canonicalForm":{"description":"Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.","readOnly":true,"type":"string"},"metadata":{"description":"Metadata about the phone number.","$ref":"#/components/schemas/FieldMetadata"}},"type":"object","description":"A person's phone number."},"Photo":{"description":"A person's photo. A picture shown next to the person's name to help others recognize the person.","properties":{"url":{"type":"string","description":"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"},"default":{"type":"boolean","description":"True if the photo is a default photo; false if the photo is a user-provided photo."},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the photo."}},"type":"object"},"ProfileMetadata":{"type":"object","properties":{"objectType":{"description":"Output only. The profile object type.","type":"string","readOnly":true,"enumDescriptions":["Unspecified.","Person.","[Currents Page.](https://workspace.google.com/products/currents/)"],"enum":["OBJECT_TYPE_UNSPECIFIED","PERSON","PAGE"]},"userTypes":{"items":{"type":"string","enum":["USER_TYPE_UNKNOWN","GOOGLE_USER","GPLUS_USER","GOOGLE_APPS_USER"],"enumDescriptions":["The user type is not known.","The user is a Google user.","The user is a Currents user.","The user is a Google Workspace user."]},"description":"Output only. The user types.","readOnly":true,"type":"array"}},"description":"The metadata about a profile."},"Relation":{"type":"object","properties":{"type":{"type":"string","description":"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`"},"formattedType":{"type":"string","description":"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.","readOnly":true},"metadata":{"description":"Metadata about the relation.","$ref":"#/components/schemas/FieldMetadata"},"person":{"description":"The name of the other person this relation refers to.","type":"string"}},"description":"A person's relation to another person."},"RelationshipInterest":{"deprecated":true,"description":"**DEPRECATED**: No data will be returned A person's relationship interest .","type":"object","properties":{"formattedValue":{"readOnly":true,"description":"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.","type":"string"},"value":{"type":"string","description":"The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`"},"metadata":{"description":"Metadata about the relationship interest.","$ref":"#/components/schemas/FieldMetadata"}}},"RelationshipStatus":{"type":"object","deprecated":true,"properties":{"value":{"type":"string","description":"The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`"},"formattedValue":{"description":"Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","type":"string","readOnly":true},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the relationship status."}},"description":"**DEPRECATED**: No data will be returned A person's relationship status."},"Residence":{"description":"**DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.","properties":{"current":{"type":"boolean","description":"True if the residence is the person's current residence; false if the residence is a past residence."},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the residence."},"value":{"description":"The address of the residence.","type":"string"}},"type":"object","deprecated":true},"SearchResponse":{"properties":{"results":{"description":"The results of the request.","items":{"$ref":"#/components/schemas/SearchResult"},"type":"array"}},"description":"The response to a search request for the authenticated user, given a query.","type":"object"},"SearchResult":{"description":"A result of a search query.","properties":{"person":{"$ref":"#/components/schemas/Person","description":"The matched Person."}},"type":"object"},"SipAddress":{"properties":{"type":{"type":"string","description":"The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`"},"value":{"description":"The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.","type":"string"},"formattedType":{"type":"string","description":"Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true},"metadata":{"description":"Metadata about the SIP address.","$ref":"#/components/schemas/FieldMetadata"}},"type":"object","description":"A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet."},"Skill":{"type":"object","description":"A skill that the person has.","properties":{"value":{"type":"string","description":"The skill; for example, `underwater basket weaving`."},"metadata":{"description":"Metadata about the skill.","$ref":"#/components/schemas/FieldMetadata"}}},"Source":{"properties":{"type":{"enumDescriptions":["Unspecified.","[Google Account](https://accounts.google.com).","[Google profile](https://profiles.google.com). You can view the profile at [https://profiles.google.com/](https://profiles.google.com/){id}, where {id} is the source id.","[Google Workspace domain profile](https://support.google.com/a/answer/1628008).","[Google contact](https://contacts.google.com). You can view the contact at [https://contact.google.com/](https://contact.google.com/){id}, where {id} is the source id.","[Google \"Other contact\"](https://contacts.google.com/other).","[Google Workspace domain shared contact](https://support.google.com/a/answer/9281635)."],"description":"The source type.","type":"string","enum":["SOURCE_TYPE_UNSPECIFIED","ACCOUNT","PROFILE","DOMAIN_PROFILE","CONTACT","OTHER_CONTACT","DOMAIN_CONTACT"]},"updateTime":{"format":"google-datetime","type":"string","readOnly":true,"description":"Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source."},"id":{"type":"string","description":"The unique identifier within the source type generated by the server."},"profileMetadata":{"description":"Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.","$ref":"#/components/schemas/ProfileMetadata","readOnly":true},"etag":{"description":"**Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.","type":"string"}},"type":"object","description":"The source of a field."},"Tagline":{"deprecated":true,"description":"**DEPRECATED**: No data will be returned A brief one-line description of the person.","type":"object","properties":{"value":{"type":"string","description":"The tagline."},"metadata":{"description":"Metadata about the tagline.","$ref":"#/components/schemas/FieldMetadata"}}},"Url":{"type":"object","description":"A person's associated URLs.","properties":{"type":{"description":"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`","type":"string"},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the URL."},"value":{"type":"string","description":"The URL."},"formattedType":{"description":"Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","type":"string","readOnly":true}}},"UserDefined":{"properties":{"value":{"type":"string","description":"The end user specified value of the user defined data."},"key":{"description":"The end user specified key of the user defined data.","type":"string"},"metadata":{"$ref":"#/components/schemas/FieldMetadata","description":"Metadata about the user defined data."}},"description":"Arbitrary user data that is populated by the end users.","type":"object"}},"securitySchemes":{"upstreamOAuth":{"type":"oauth2","description":"Upstream Google OAuth scope used by the proxy (agents use AAuth, not this scheme).","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"https://www.googleapis.com/auth/contacts":"contacts","https://www.googleapis.com/auth/contacts.other.readonly":"contacts.other.readonly","https://www.googleapis.com/auth/contacts.readonly":"contacts.readonly"}}}}}}}