Enumerar personas

Espacio de nombres: microsoft.graph

Recupera una colección de objetos person ordenados por su relevancia para el user, que viene determinada por las relaciones empresariales y los patrones de comunicación y colaboración del usuario.

Puede obtener esta información a través de la API de contactos. Para obtener ejemplos, vea la sección Ejemplos y el artículo sobre cómo Obtener información relevante sobre los contactos.

Permisos

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.

Tipo de permiso Permisos (de menos a más privilegiados)
Delegado (cuenta profesional o educativa) People.Read, People.Read.All
Delegado (cuenta personal de Microsoft) People.Read
Aplicación People.Read.All

Solicitud HTTP

GET /me/people
GET /users/{id | userPrincipalName}/people

Parámetros de consulta opcionales

Este método admite los parámetros de consulta de OData para que le resulte más fácil personalizar la respuesta, como se muestra en los ejemplos del artículo Obtener información relevante sobre contactos.

Nombre Valor Descripción
$filter string Limita la respuesta a solo los contactos cuyo registro contiene los criterios especificados.
$orderby cadena De forma predeterminada, las personas de la respuesta se ordenan por su relevancia para la consulta. Puede cambiar el orden de las personas en la respuesta utilizando el parámetro $orderby.
$search string Busca contactos por nombre o alias. Admite la coincidencia aproximada. Parámetro solo funciona para buscar los contactos relevantes del usuario que haya iniciado sesión, no para buscar contactos relevantes para otros usuarios. También es compatible con la palabra clave topic para encontrar contactos basados en temas extraídos de conversaciones de correo electrónico con esa persona. Para información y ejemplos, consulte la sección Realizar una búsqueda parcial en Obtener información relevante sobre personas.
$select string Lista separada por comas de las propiedades que se van a incluir en la respuesta. Para un rendimiento óptimo, seleccione solo el subconjunto de propiedades necesarias.
$skip int Se omiten los primeros resultados n, útil para la paginación. Esta opción no se admite cuando se usa $search.
$top int Número de resultados que se van a devolver.

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio.
Aceptar application/json

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y una colección de objetos person en el cuerpo de la respuesta. La respuesta puede contener un objeto person o una colección de objetos person.

Ejemplos

Solicitud

Aquí tiene un ejemplo de la solicitud.

GET https://graph.microsoft.com/v1.0/me/people

Respuesta

Aquí tiene un ejemplo de la respuesta.

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

{
    "value": [
        {
            "id": "33b43a5b-87d6-41ec-91f8-a2610048105f",
            "displayName": "Marketing",
            "givenName": null,
            "surname": null,
            "birthday": "",
            "personNotes": "",
            "isFavorite": false,
            "jobTitle": null,
            "companyName": null,
            "yomiCompany": "",
            "department": null,
            "officeLocation": null,
            "profession": "",
            "userPrincipalName": "",
            "imAddress": null,
            "scoredEmailAddresses": [
                {
                    "address": "Marketing@contoso.com",
                    "relevanceScore": 30.0
                }
            ],
            "phones": [],
            "postalAddresses": [],
            "websites": [],
            "personType": {
                "class": "Group",
                "subclass": "UnifiedGroup"
            }
        },
        {
            "id": "e3d0513b-449e-4198-ba6f-bd97ae7cae85",
            "displayName": "Isaiah Langer",
            "givenName": "Isaiah",
            "surname": "Langer",
            "birthday": "",
            "personNotes": "",
            "isFavorite": false,
            "jobTitle": "Web Marketing Manager",
            "companyName": null,
            "yomiCompany": "",
            "department": "Sales & Marketing",
            "officeLocation": "20/1101",
            "profession": "",
            "userPrincipalName": "IsaiahL@contoso.com",
            "imAddress": "sip:isaiahl@contoso.com",
            "scoredEmailAddresses": [
                {
                    "address": "IsaiahL@contoso.com",
                    "relevanceScore": 20.0
                }
            ],
            "phones": [
                {
                    "type": "business",
                    "number": "+1 918 555 0101"
                }
            ],
            "postalAddresses": [],
            "websites": [],
            "personType": {
                "class": "Person",
                "subclass": "OrganizationUser"
            }
        }
    ]
}

Para obtener ejemplos, vea el artículo Obtener información relevante sobre los contactos.