# Contacts

> Consultez et mettez à jour les informations des contacts

- Page: https://tbit.app/fr/docs/api/contacts
- URL de base: `https://rest-api.tbit.app/v1`
- Authentification: en-tête `X-API-Key` avec votre clé dans chaque requête (les exemples la lisent depuis la variable d'environnement `TBIT_API_KEY`)

## Vue d'ensemble

Les contacts représentent les personnes qui échangent avec votre agent sur des canaux comme WhatsApp, Instagram et l'e-mail. Chaque contact a un profil avec un nom, des identifiants de canal et des métadonnées facultatives.

## Endpoints

| Méthode | Chemin | Description |
| --- | --- | --- |
| `GET` | `/v1/contacts` | Lister les contacts |
| `GET` | `/v1/contacts/:id` | Obtenir le détail d'un contact |
| `POST` | `/v1/contacts` | Créer un contact |
| `PATCH` | `/v1/contacts/:id` | Mettre à jour un contact |

## Paramètres de requête

L'endpoint de liste accepte les paramètres de requête suivants :

| Paramètre | Type | Description |
| --- | --- | --- |
| `limit` | `number` | Résultats par page (par défaut : 20, max : 100) |
| `offset` | `number` | Nombre de résultats à sauter (par défaut : 0) |

## Lister les contacts

`GET /v1/contacts`

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

## Obtenir le détail d'un contact

`GET /v1/contacts/64f1a2b3c4d5e6f7a8b9c0d1`

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

## Mettre à jour un contact

`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"
  }'
```

## Créer un contact

`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"
    }
  }'
```

## Format de réponse

Les endpoints de liste renvoient des résultats paginés :

```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
  }
}
```