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

# GET Lister les instances

> Liste toutes les instances WhatsApp actives de votre compte.

## Endpoint

```txt theme={null}
GET /api/v1/instances
```

## Authentification

`x-api-key: <api_key>`

## Paramètres

Aucun paramètre path, query ou body.

## Exemple de requête

```bash theme={null}
curl https://srv.msgflash.com/api/v1/instances \
  -H "x-api-key: msgf_live_your_api_key_here"
```

## Réponse succès `200`

```json theme={null}
{
  "data": [
    {
      "id": "inst_uuid",
      "name": "boutique-principale",
      "waNumber": "+33612345678",
      "status": "connected",
      "webhook": null,
      "meta": null,
      "deletedAt": null,
      "createdAt": "2026-04-01T09:00:00.000Z",
      "updatedAt": "2026-04-01T09:10:00.000Z"
    }
  ]
}
```

## Comment obtenir le bon `instanceId`

Pour tous les endpoints d'envoi MsgFlash, vous devez utiliser `instanceId`.

Différence entre les champs :

| Champ      | Usage                                                         |
| ---------- | ------------------------------------------------------------- |
| `id`       | Identifiant technique à envoyer comme `instanceId` dans l'API |
| `name`     | Nom lisible pour l'utilisateur, utile pour l'UI               |
| `waNumber` | Numéro WhatsApp connecté, utile pour affichage/contrôle       |

Flow recommandé :

1. appeler `GET /api/v1/instances`
2. choisir une instance avec `status = "connected"`
3. récupérer `data[n].id`
4. utiliser cette valeur comme `instanceId` dans :
   * `POST /api/v1/messages/send`
   * `POST /api/v1/messages/schedule`
   * `POST /api/v1/campaigns`

## Erreurs courantes

| HTTP  | Code                      | Quand                        |
| ----- | ------------------------- | ---------------------------- |
| `401` | `UNAUTHORIZED`            | Clé API absente ou invalide  |
| `429` | `API_RATE_LIMIT_EXCEEDED` | Trop de requêtes par seconde |