person resource type

Namespace: microsoft.graph


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents an aggregation of information about a person from across mail and contacts. People can be local contacts or your organization's directory, and people from recent communications (such as email).


Method Return Type Description
List people person Get a collection of person objects ordered by their relevance to the user.


Property Type Description
birthday String The person's birthday.
companyName String The name of the person's company.
department String The person's department.
displayName String The person's display name.
emailAddresses rankedEmailAddress collection The person's email addresses.
givenName String The person's given name.
id String The person's unique identifier. Read-only.
isFavorite Boolean True if the user has flagged this person as a favorite.
mailboxType String The type of mailbox that is represented by the person's email address.
officeLocation String The location of the person's office.
personNotes String Free-form notes that the user has taken about this person.
personType String The type of person, for example distribution list.
phones phone collection The person's phone numbers.
postalAddresses location collection The person's addresses.
profession String The person's profession.
sources personDataSource collection The sources the user data comes from, for example Directory or Outlook Contacts.
surname String The person's surname.
title String The person's title.
userPrincipalName String The user principal name (UPN) of the person. The UPN is an Internet-style login name for the person based on the Internet standard RFC 822. By convention, this should map to the person's email name. The general format is alias@domain.
websites website collection The person's websites.
yomiCompany String The phonetic Japanese name of the person's company.



JSON representation

The following is a JSON representation of the resource.

  "birthday": "String",
  "companyName": "String",
  "department": "String",
  "displayName": "String",
  "emailAddresses": [{"@odata.type": "microsoft.graph.rankedEmailAddress"}],
  "givenName": "String",
  "id": "String (identifier)",
  "isFavorite": "Boolean",
  "mailboxType": "String",
  "officeLocation": "String",
  "personNotes": "String",
  "personType": "String",
  "phones": [{"@odata.type": ""}],
  "postalAddresses": [{"@odata.type": "microsoft.graph.location"}],
  "profession": "String",
  "sources": [{"@odata.type": "microsoft.graph.personDataSource"}],
  "surname": "String",
  "title": "String",
  "userPrincipalName": "String",
  "websites": [{"@odata.type": ""}],
  "yomiCompany": "String"