> ## 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.

# Formato de respuesta

> Como estan estructuradas las respuestas de la API de Wappfy — el formato estandar, paginacion y formato de errores.

# Formato de respuesta

Todas las respuestas de la API de Wappfy siguen un formato de envoltura consistente.

## Respuestas exitosas

Toda respuesta exitosa esta envuelta en un objeto estandar:

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

| Campo            | Tipo              | Descripcion                                         |
| ---------------- | ----------------- | --------------------------------------------------- |
| `success`        | `boolean`         | Siempre `true` en respuestas exitosas               |
| `data`           | `object \| array` | El contenido de la respuesta                        |
| `meta.requestId` | `string`          | Identificador unico de la solicitud para depuracion |
| `meta.timestamp` | `string`          | Marca de tiempo en formato ISO 8601                 |

## Respuestas paginadas

Los endpoints que devuelven listas incluyen metadatos de paginacion:

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

Usa los parametros de consulta `page` y `limit` para controlar la paginacion:

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

## Respuestas de error

Las solicitudes fallidas devuelven un objeto de error:

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

### Codigos de error comunes

| Estado HTTP | Codigo                | Descripcion                                     |
| ----------- | --------------------- | ----------------------------------------------- |
| `400`       | `VALIDATION_ERROR`    | El cuerpo de la solicitud no paso la validacion |
| `401`       | `UNAUTHORIZED`        | Token de autenticacion ausente o invalido       |
| `403`       | `FORBIDDEN`           | Permisos insuficientes                          |
| `404`       | `NOT_FOUND`           | El recurso no existe                            |
| `409`       | `PLAN_LIMIT_REACHED`  | Limite de instancias de tu plan alcanzado       |
| `429`       | `RATE_LIMIT_EXCEEDED` | Demasiadas solicitudes                          |
| `500`       | `INTERNAL_ERROR`      | Error inesperado del servidor                   |

<Note>
  El `meta.requestId` es util para solicitudes de soporte — incluyelo al contactar al equipo de soporte para una depuracion mas rapida.
</Note>