List people

Retrieve a list of person objects ordered by their relevance to the user, which is determined by the user's communication, collaboration and business relationships.

Prerequisites

The following scopes are required to execute this API: People.Read; People.ReadWrite

HTTP request

GET /users/{id | userPrincipalName}/people

Optional query parameters

This method supports the OData Query Parameters to help customize the response.

Request headers

Name Description
Authorization Bearer <code>
Accept application/json

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of person objects in the response body.

Examples

Request

Here is an example of the request.

GET https://graph.microsoft.com/beta/me/people

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 346

{
  "value": [
    {
      "sources": [
        {
          "type": "type-value"
        }
      ],
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "surname": "surname-value",
      "title": "title-value",
      "emailAddresses": [
        {
          "address": "address-value"
        }
      ]
    }
  ]
}