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

> Lê as configurações de privacidade atuais da conta

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

## Descrição

Retorna **todas** as configurações de privacidade da conta conectada agrupadas em três subobjetos: `visibility`, `privacy` e `permissions`.

## Exemplos

### Padrão

Lê o snapshot completo de privacidade da conta agrupado em `visibility`, `privacy` e `permissions`. Sem query params nem body, leitura simples para conferir o estado atual antes de chamar o `POST` correspondente.

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

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/profile/getPrivacy/${process.env.Instance_Name}`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

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

  requests.get(
      f"https://ryzeapi.cloud/api/profile/getPrivacy/{os.environ['Instance_Name']}",
      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/profile/getPrivacy/"+os.Getenv("Instance_Name"), nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

Retorna o snapshot completo de privacidade em `settings`, agrupado em três subobjetos: `visibility` (`lastSeen`, `status`, `profile`, `online`), `privacy` (`readReceipts`) e `permissions` (`callAdd`, `groupAdd`). Os valores vêm do store local sincronizado via appstate, alterações feitas no app oficial podem demorar alguns segundos para refletir.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Privacy settings retrieved successfully",
  "settings": {
    "visibility": {
      "lastSeen": "contacts",
      "status": "all",
      "profile": "contacts",
      "online": "match_last_seen"
    },
    "privacy": {
      "readReceipts": "all"
    },
    "permissions": {
      "callAdd": "all",
      "groupAdd": "contacts"
    }
  }
}
```

## Parâmetros de rota

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

## Headers

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

## Valores aceitos

| Campo                             | Valores                                           |
| --------------------------------- | ------------------------------------------------- |
| `lastSeen` / `status` / `profile` | `all` / `contacts` / `contact_blacklist` / `none` |
| `online`                          | `all` / `match_last_seen`                         |
| `readReceipts`                    | `all` / `none`                                    |
| `callAdd`                         | `all` / `known`                                   |
| `groupAdd`                        | `all` / `contacts` / `contact_blacklist`          |

## Notas

<Note>
  * Os valores vêm primariamente do store local do whatsmeow, sincronizado via appstate. Alterações feitas pelo app oficial aparecem aqui com latência de segundos.
  * `online: match_last_seen` significa que sua presença online segue a regra de `lastSeen`, se `lastSeen=none`, ninguém te vê online também.
  * Defaults para contas recém-criadas: tudo em `all`.
</Note>

## Erros

| HTTP | Mensagem                                |
| ---- | --------------------------------------- |
| 400  | `Instance is not connected to WhatsApp` |
| 404  | `Instance not found`                    |

Envelope:

```json theme={null}
{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}
```