# Listar contatos

`GET /contacts`

Pasta: **Contatos**

## Autenticação

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

## Descrição

# Listar contatos

Retorna até 1000 contatos conhecidos pela instância. Use para carregar a agenda rapidamente; para listas grandes com paginação, prefira `POST /contacts/list`.

## Endpoint

`GET {{baseUrl}}/contacts`

## Autenticação

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

## Parâmetros

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `contactScope` | string | Não | Escopo dos contatos. Padrão: `address_book`. Valores: `address_book` (com nome na agenda), `outside_address_book` (sem nome na agenda), `all` (todos). |

## Exemplo de Requisição

```bash
curl --request GET '{{baseUrl}}/contacts?contactScope=address_book' \
  --header 'token: {{token}}'
```

## Resposta de Sucesso

```json
[
  {
    "jid": "5511999999999@s.whatsapp.net",
    "contact_name": "João Silva",
    "contact_FirstName": "João"
  }
]
```

## Erros comuns

- `401 Unauthorized`: o header `token` não foi enviado ou é inválido.
- `500 Internal Server Error`: instância desconectada ou store de contatos indisponível.

## Observações

- A resposta é um array direto (não vem envelopada em `{ success, contacts }`).
- Campos retornados: `jid`, `contact_name`, `contact_FirstName`.
- Limite interno: 1000 contatos (offset 0).

## Query

- `contactScope` = `address_book`

## cURL

```bash
curl -X GET "{{baseUrl}}/contacts" \
  -H "token: {{token}}"
```

---

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