> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET (/users/{ownerId}/people)

> GET (/users/\{ownerId}/people)

# GET (/users/\{ownerId}/people)

Obtém a coleção de pessoas do chamador.
O domínio desses URIs é `social.xboxlive.com`.

* [Comentários](#ID4EV)
* [Parâmetros de URI](#ID4E5)
* [Parâmetros da cadeia de caracteres de consulta](#ID4EJB)
* [Autorização](#ID4ERD)
* [Cabeçalhos de solicitação obrigatórios](#ID4EZE)
* [Cabeçalhos de solicitação opcionais](#ID4EYF)
* [Corpo da solicitação](#ID4E5G)
* [Códigos de status HTTP](#ID4EJH)
* [Cabeçalhos de resposta obrigatórios](#ID4EBBAC)
* [Corpo da resposta](#ID4ENCAC)

## Comentários

As operações GET não modificam nenhum recurso, portanto produzirão os mesmos resultados se forem executadas uma ou várias vezes.

## Parâmetros de URI

| Parâmetro | Tipo | Descrição |
| - | - | - |
| ownerId | string | Identificador do usuário cujo recurso está sendo acessado. Deve corresponder ao usuário autenticado. Os valores possíveis são "me", xuid(\{xuid}) ou gt(\{gamertag}). |

## Parâmetros da cadeia de caracteres de consulta

| Parâmetro | Tipo | Descrição |
| - | - | - |
| view | string | Retorna as pessoas associadas a uma exibição. O valor padrão é "all". Os valores possíveis são: **All** - Retorna todas as Pessoas da lista de Pessoas do usuário. Este é o valor padrão. **Favorite** - Retorna todas as Pessoas da lista de Pessoas do usuário que têm o atributo Favorite. **LegacyXboxLiveFriends** - Retorna todas as Pessoas da lista de Pessoas do usuário que também são amigos herdados do XBOX Live. **Observação:**  Somente o valor **All** tem suporte se o usuário chamador for diferente do usuário proprietário. |
| startIndex | inteiro sem sinal de 32 bits | Retorna os itens a partir do índice fornecido. |
| maxItems | inteiro sem sinal de 32 bits | Número máximo de pessoas a serem retornadas da coleção a partir do índice inicial. O serviço pode fornecer um valor padrão se **maxItems** não estiver presente e pode retornar menos do que **maxItems** (mesmo que a última página de resultados ainda não tenha sido retornada). |

## Autorização

| Tipo | Obrigatório | Descrição | Resposta se ausente |
| - | - | - | - |
| XUID | sim | O chamador tem a ID de usuário do XBOX (XUID) do usuário. | 401 Unauthorized |

## Cabeçalhos de solicitação obrigatórios

| Cabeçalho | Descrição |
| - | - |
| Authorization | String. Dados de autorização para o XBOX Live. Normalmente, é um token XSTS criptografado. Valor de exemplo: **XBL3.0 x=\<userhash>;\<token>**. |

## Cabeçalhos de solicitação opcionais

| Cabeçalho | Descrição |
| - | - |
| X-RequestedServiceVersion | Nome/número do build do serviço XBOX Live para o qual esta solicitação deve ser direcionada. A solicitação só será roteada para esse serviço após a verificação da validade do cabeçalho, das declarações no token de autenticação e assim por diante. Valor padrão: 1. |
| Accept | String. Content-Types que o chamador aceita na resposta. Todas as respostas são **application/json**. |

## Corpo da solicitação

Nenhum objeto é enviado no corpo desta solicitação.

## Códigos de status HTTP

O serviço retorna um dos códigos de status desta seção em resposta a uma solicitação feita com este método neste recurso. Para obter uma lista completa dos códigos de status HTTP padrão usados com os Serviços do XBOX Live, confira [Códigos de status HTTP padrão](https://docs.xbox.com/pt-BR/reference/live/rest/additional/httpstatuscodes.md).

| Código | Frase de motivo | Descrição |
| - | - | - |
| 200 | OK | Êxito. |
| 400 | Bad Request | Os parâmetros de consulta ou as IDs de usuário estavam malformados. |
| 403 | Forbidden | Não foi possível analisar a declaração de XUID do cabeçalho de autorização. |

## Cabeçalhos de resposta obrigatórios

| Cabeçalho | Tipo | Descrição |
| - | - | - |
| Content-Length | inteiro sem sinal de 32 bits | Comprimento, em bytes, do corpo da resposta. Valor de exemplo: 22. |
| Content-Type | string | Tipo MIME do corpo da resposta. Sempre será **application/json**. |

## Corpo da resposta

Se a chamada for bem-sucedida, o serviço retornará o número total de pessoas na coleção de pessoas do chamador e uma matriz contendo a coleção de pessoas do chamador. Confira [PeopleList (JSON)](https://docs.xbox.com/pt-BR/reference/live/rest/json/json-peoplelist.md).

### Exemplo de resposta

```json theme={null}
{
    "people": [
        {
            "xuid": "2603643534573573",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573572",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573577",
            "isFollowingCaller": false,
            "isFavorite": false
        },
    ],
    "totalCount": 3
}

```

## Confira também

##### Pai

[/users/\{ownerId}/people](https://docs.xbox.com/pt-BR/reference/live/rest/uri/people/uri-usersowneridpeople.md)


## Related topics

- [GET (/users/{ownerId}/people/mute)](https://docs.xbox.com/pt-BR/reference/live/rest/uri/privacy/uri-privacyusersowneridpeoplemuteget.md)
- [GET (/users/{ownerId}/people/avoid)](https://docs.xbox.com/pt-BR/reference/live/rest/uri/privacy/uri-privacyusersxuidpeopleavoidget.md)
- [GET (/users/{ownerId}/people/{targetid})](https://docs.xbox.com/pt-BR/reference/live/rest/uri/people/uri-usersowneridpeopletargetidget.md)
- [XblSocialGetSocialRelationshipsAsync](https://docs.xbox.com/pt-BR/reference/live/xsapi-c/social_c/functions/xblsocialgetsocialrelationshipsasync.md)
- [/users/{ownerId}/people](https://docs.xbox.com/pt-BR/reference/live/rest/uri/people/uri-usersowneridpeople.md)
