# Buscar usernames de contatos

`POST /user/username/fetch`

Pasta: **Usuários**

## Autenticação

```http
token: {{token}}
```

## Descrição

# Buscar usernames de contatos

Consulta os usernames associados a uma lista de números/JIDs via USync. Use para descobrir quais contatos já configuraram um username público.

## Endpoint

`POST {{baseUrl}}/user/username/fetch`

## Autenticação

Envie o token da instância no header `token: {{token}}`.

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `numbers` | array<string> | Sim* | Telefones com DDI. Informe `numbers` e/ou `jids`. |
| `jids` | array<string> | Sim* | JIDs completos. Alternativa/complemento a `numbers`. |

## Exemplo de Requisição

```bash
curl --request POST '{{baseUrl}}/user/username/fetch' \
  --header 'token: {{token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "numbers": ["5511999999999"]
}'
```

## Resposta de Sucesso

```json
{
  "success": true,
  "contacts": [
    { "jid": "5511999999999@s.whatsapp.net", "username": "foo" }
  ]
}
```

## Erros comuns

- `401 Unauthorized`: o header `token` não foi enviado ou é inválido.
- `400 Bad Request`: o JSON está malformado ou contém um identificador inválido.
- `500 Internal Server Error`: a conexão com o WhatsApp falhou ou a operação foi recusada.

## Observações

* Informe **ao menos um** de: `numbers` ou `jids`. Contatos sem username não aparecem no resultado.

## Corpo (exemplo)

```json
{
  "numbers": ["5511999999999"]
}
```

## cURL

```bash
curl -X POST "{{baseUrl}}/user/username/fetch" \
  -H "token: {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "numbers": ["5511999999999"]
}'
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=usuarios/buscar-usernames-de-contatos)
