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

# Format de reponse

> Structure des reponses de l'API Wappfy — le format standard d'enveloppe, la pagination et le format d'erreur.

# Format de reponse

Toutes les reponses de l'API Wappfy suivent un format d'enveloppe coherent.

## Reponses de succes

Chaque reponse reussie est encapsulee dans un objet standard :

```json theme={null}
{
  "success": true,
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
```

| Champ            | Type              | Description                                       |
| ---------------- | ----------------- | ------------------------------------------------- |
| `success`        | `boolean`         | Toujours `true` pour les reponses reussies        |
| `data`           | `object \| array` | Le contenu de la reponse                          |
| `meta.requestId` | `string`          | Identifiant unique de la requete pour le debogage |
| `meta.timestamp` | `string`          | Horodatage ISO 8601                               |

## Reponses paginées

Les endpoints qui retournent des listes incluent des metadonnees de pagination :

```json theme={null}
{
  "success": true,
  "data": {
    "items": [ ... ],
    "total": 42,
    "page": 1,
    "limit": 20,
    "totalPages": 3
  },
  "meta": {
    "requestId": "req_def456",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
```

Utilisez les parametres de requete `page` et `limit` pour controler la pagination :

```bash theme={null}
GET /api/instances?page=2&limit=10
```

## Reponses d'erreur

Les requetes echouees retournent un objet d'erreur :

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INSTANCE_NOT_FOUND",
    "message": "Instance with ID abc123 not found",
    "details": {}
  },
  "meta": {
    "requestId": "req_ghi789",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
```

### Codes d'erreur courants

| Statut HTTP | Code                  | Description                                        |
| ----------- | --------------------- | -------------------------------------------------- |
| `400`       | `VALIDATION_ERROR`    | Le corps de la requete n'a pas passe la validation |
| `401`       | `UNAUTHORIZED`        | Jeton d'authentification manquant ou invalide      |
| `403`       | `FORBIDDEN`           | Permissions insuffisantes                          |
| `404`       | `NOT_FOUND`           | La ressource n'existe pas                          |
| `409`       | `PLAN_LIMIT_REACHED`  | Limite d'instances atteinte pour votre forfait     |
| `429`       | `RATE_LIMIT_EXCEEDED` | Trop de requetes                                   |
| `500`       | `INTERNAL_ERROR`      | Erreur serveur inattendue                          |

<Note>
  Le `meta.requestId` est utile pour les demandes de support — incluez-le lorsque vous contactez le support pour un debogage plus rapide.
</Note>
