# Contatos

> Consulte e atualize as informações dos contatos

- Página: https://tbit.app/pt/docs/api/contacts
- URL base: `https://rest-api.tbit.app/v1`
- Autenticação: cabeçalho `X-API-Key` com a sua chave em cada requisição (os exemplos a leem da variável de ambiente `TBIT_API_KEY`)

## Visão geral

Os contatos representam as pessoas que interagem com o seu agente por canais como WhatsApp, Instagram e e-mail. Cada contato tem um perfil com nome, identificadores de canal e metadados opcionais.

## Endpoints

| Método | Rota | Descrição |
| --- | --- | --- |
| `GET` | `/v1/contacts` | Listar contatos |
| `GET` | `/v1/contacts/:id` | Obter o detalhe de um contato |
| `POST` | `/v1/contacts` | Criar um contato |
| `PATCH` | `/v1/contacts/:id` | Atualizar um contato |

## Parâmetros de consulta

O endpoint de listagem aceita os seguintes parâmetros de consulta:

| Parâmetro | Tipo | Descrição |
| --- | --- | --- |
| `limit` | `number` | Resultados por página (padrão: 20, máx.: 100) |
| `offset` | `number` | Quantidade de resultados a pular (padrão: 0) |

## Listar contatos

`GET /v1/contacts`

```bash
curl "https://rest-api.tbit.app/v1/contacts?limit=20&offset=0" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Obter o detalhe de um contato

`GET /v1/contacts/64f1a2b3c4d5e6f7a8b9c0d1`

```bash
curl "https://rest-api.tbit.app/v1/contacts/64f1a2b3c4d5e6f7a8b9c0d1" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Atualizar contato

`PATCH /v1/contacts/64f1a2b3c4d5e6f7a8b9c0d1`

```bash
curl -X PATCH "https://rest-api.tbit.app/v1/contacts/64f1a2b3c4d5e6f7a8b9c0d1" \
  -H "X-API-Key: $TBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_name": "Jane Doe",
    "email": "jane@example.com",
    "notes": "Preferred language: English"
  }'
```

## Criar contato

`POST /v1/contacts`

```bash
curl -X POST "https://rest-api.tbit.app/v1/contacts" \
  -H "X-API-Key: $TBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "573009876543",
    "channel_type": "whatsapp",
    "profile_name": "Jane Doe",
    "custom_attributes": {
      "city": "Bogota",
      "plan": "premium"
    }
  }'
```

## Formato da resposta

Os endpoints de listagem retornam resultados paginados:

```json
{
  "data": [
    {
      "id": "64f1a2b3c4d5e6f7a8b9c0d1",
      "profile_name": "Jane Doe",
      "email": "jane@example.com",
      "notes": "Preferred language: English",
      "channels": [
        {
          "channel_id": "573001234567",
          "channel_type": "whatsapp"
        }
      ],
      "custom_attributes": {
        "city": "Bogota",
        "plan": "premium"
      },
      "created_at": "2024-09-01T12:00:00Z",
      "updated_at": "2024-09-01T14:30:00Z"
    }
  ],
  "pagination": {
    "total": 50,
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}
```