Listar pessoasList people

Namespace: microsoft.graphNamespace: microsoft.graph

Recupere uma coleção de objetos person ordenados por relevância para o usuário, o que é determinado pelo padrões de comunicação e colaboração e pelas relações comerciais do usuário.Retrieve a collection of person objects ordered by their relevance to the user, which is determined by the user's communication and collaboration patterns, and business relationships.

Você pode obter essas informações por meio da API de Pessoas. Para ver exemplos, confira a seção Exemplos e o artigo Obter informações relevantes sobre as pessoas.You can get this information via the People API. For examples, see the Examples section and the article Get relevant information about people.

PermissõesPermissions

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permissãoPermission type Permissões (da com menos para a com mais privilégios)Permissions (from least to most privileged)
Delegado (conta corporativa ou de estudante)Delegated (work or school account) People.Read, People.Read.AllPeople.Read, People.Read.All
Delegado (conta pessoal da Microsoft)Delegated (personal Microsoft account) People.ReadPeople.Read
AplicativoApplication People.Read.AllPeople.Read.All

Solicitação HTTPHTTP request

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

Parâmetros de consulta opcionaisOptional query parameters

Este método oferece suporte aos parâmetros de consulta OData para personalizar a resposta, como mostrado nos exemplos no artigo Obter informações relevantes sobre pessoas.This method supports the OData query parameters to help customize the response, as shown in the examples in the article Get relevant information about people.

NomeName ValorValue DescriçãoDescription
$filter$filter stringstring Limita a resposta apenas às pessoas cujo registro contém os critérios especificados.Limits the response to only those people whose record contains the specified criteria.
$orderby$orderby cadeia de caracteresstring Por padrão, as pessoas na resposta são classificadas pela relevância delas à consulta.By default the people in the response are sorted by their relevance to your query. Você pode alterar a ordem das pessoas na resposta usando o parâmetro $orderby.You can change the order of the people in the response using the $orderby parameter.
$search$search stringstring Pesquisar pessoas por nome ou alias.Search for people by name or alias. Suporta correspondência difusa.Supports Fuzzy matching. O parâmetro só funciona para pesquisar pessoas relevantes do usuário conectado, não para pesquisar pessoas relevantes para outros usuários.Parameter only works for searching the signed-in user's relevant people, not for searching people relevant to other users. Também dá suporte a topic palavra-chave para encontrar pessoas com base em tópicos extraídos a partir de conversas de email com essa pessoa.Also supports the topic keyword to find people based on topics extracted from e-mail conversations with that person. Confira a seção *Realizar uma pesquisa difusa * em Obter informações relevantes sobre pessoas para informações e exemplos.See the Perform a fuzzy search section at Get relevant information about people for information and examples.
$select$select stringstring Lista separada por vírgulas de propriedades para incluir na resposta. Para um desempenho ideal, selecione apenas o subconjunto de propriedades necessário.Comma-separated list of properties to include in the response. For optimal performance, only select the subset of properties needed.
$skip$skip intint Ignorar os primeiros n resultados, útil para paginação. Não é suportado ao usar $search.Skip the first n results, useful for paging. This is not supported when using $search.
$top$top intint Número de resultados a ser retornado.Number of results to be returned.

Cabeçalhos de solicitaçãoRequest headers

NomeName DescriçãoDescription
AutorizaçãoAuthorization {token} de portador. Obrigatório.Bearer {token}. Required.
AceitarAccept application/jsonapplication/json

Corpo da solicitaçãoRequest body

Não forneça um corpo de solicitação para esse método.Do not supply a request body for this method.

RespostaResponse

Se bem-sucedido, este método retorna um código de resposta 200 OK e uma coleção de objetos person no corpo da resposta. A resposta pode conter um objeto person ou uma coleção de objetos person.If successful, this method returns a 200 OK response code and a collection of person objects in the response body. The response can contain one person object or a collection of person objects.

ExemplosExamples

SolicitaçãoRequest

Este é um exemplo de solicitação.The following is an example of the request.

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

RespostaResponse

Este é um exemplo de resposta.The following is an example of the response.

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 ver mais exemplos, confira o artigo Obter informações relevantes sobre as pessoas.For more examples, see the article Get relevant information about people.