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

# Leer settings

> Lee los settings de comportamiento de la instancia

**Auth:** `TokenAccount` o `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sí

## Descripción

Devuelve los 7 flags de comportamiento de la instancia: rechazo de llamadas, ignorar grupos, mantener online, marcar como leído, sincronización de historial, ignorar status.

## Ejemplo

Realiza un `GET` en la ruta de la instancia y devuelve el objeto `settings` con todos los flags actuales. No se aceptan query params, solo el nombre en el path y el `token` en la cabecera.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/instance/getSettings/my-instance" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch("https://ryzeapi.cloud/api/instance/getSettings/my-instance", {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.get(
      "https://ryzeapi.cloud/api/instance/getSettings/my-instance",
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/instance/getSettings/my-instance", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Respuesta exitosa

```json 200 OK theme={null}
{
  "success": true,
  "message": "Settings retrieved successfully",
  "settings": {
    "autoRejectCalls": false,
    "callRejectMessage": "",
    "ignoreGroupMessages": false,
    "keepOnlineStatus": false,
    "autoReadMessages": false,
    "disableHistorySync": true,
    "ignoreStatus": false
  }
}
```

## Parámetros de ruta

<ParamField path="instance" type="string" required>
  Nombre de la instancia.
</ParamField>

## Cabeceras

<ParamField header="token" type="string" required>
  TokenAccount o TokenInstance.
</ParamField>

## Campos

| Campo                 | Tipo    | Descripción                                                 |
| --------------------- | ------- | ----------------------------------------------------------- |
| `autoRejectCalls`     | boolean | Rechaza llamadas automáticamente                            |
| `callRejectMessage`   | string  | Mensaje enviado al rechazar                                 |
| `ignoreGroupMessages` | boolean | Ignora eventos de grupo en la ingesta                       |
| `keepOnlineStatus`    | boolean | Mantiene presencia como `available`                         |
| `autoReadMessages`    | boolean | Marca mensajes recibidos como leídos                        |
| `disableHistorySync`  | boolean | Deshabilita la sincronización de historial (default `true`) |
| `ignoreStatus`        | boolean | Ignora mensajes de tipo "status" (stories)                  |

## Errores

| HTTP | `error.message`                         | Cuándo                     |
| :--: | --------------------------------------- | -------------------------- |
|  401 | `Invalid token`                         | Token faltante o inválido. |
|  404 | `Instance not found`                    | Nombre no existe.          |
|  429 | `Rate limit exceeded. Try again later.` | Más de 100 req/min.        |
|  500 | `Failed to get settings configuration`  | Error de base de datos.    |

```json theme={null}
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}
```

## Siguiente

<CardGroup cols={2}>
  <Card title="Actualizar settings" icon="pen-to-square" href="/es/api/instance/settings-update">
    `POST /api/instance/settings/:instance` para cambiar.
  </Card>
</CardGroup>