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

# Verificar Configurações

> Lê as configurações de comportamento da instância

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sim

## Descrição

Retorna as 7 flags de comportamento da instância: rejeição de chamadas, ignorar grupos, manter online, marcar como lida, sync de histórico, ignorar status.

## Exemplo

Faz `GET` no path da instância e devolve o objeto `settings` com todas as flags atuais. Não aceita query params, apenas o nome no path e o `token` no header.

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

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

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

  requests.get(
      "https://ryzeapi.cloud/api/instance/getSettings/minha-instancia",
      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/minha-instancia", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

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

## Path parameters

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

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

## Campos

| Campo                 | Tipo    | Descrição                                   |
| --------------------- | ------- | ------------------------------------------- |
| `autoRejectCalls`     | boolean | Rejeita chamadas automaticamente            |
| `callRejectMessage`   | string  | Mensagem enviada ao rejeitar                |
| `ignoreGroupMessages` | boolean | Ignora eventos de grupo na ingestão         |
| `keepOnlineStatus`    | boolean | Mantém presença `available`                 |
| `autoReadMessages`    | boolean | Marca mensagens recebidas como lidas        |
| `disableHistorySync`  | boolean | Desliga sync de histórico (default `true`)  |
| `ignoreStatus`        | boolean | Ignora mensagens do tipo "status" (stories) |

## Erros

| HTTP | `error.message`                         | Quando                     |
| :--: | --------------------------------------- | -------------------------- |
|  401 | `Invalid token`                         | Token ausente ou inválido. |
|  404 | `Instance not found`                    | Nome não existe.           |
|  429 | `Rate limit exceeded. Try again later.` | Mais de 100 req/min.       |
|  500 | `Failed to get settings configuration`  | Erro de banco.             |

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

## Próximo

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