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

# Listar etiquetas

> Lista todas as etiquetas (labels) cadastradas na instância

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

## Descrição

Retorna todas as etiquetas conhecidas pela instância, incluindo as criadas via API e as importadas via app state do WhatsApp. Cada etiqueta carrega um `id`, `name`, `color` (paleta nativa do WhatsApp), `type` e flag `deleted`.

<Info>
  `color` é um inteiro entre **0 e 10** que mapeia para as cores oficiais do WhatsApp Business. Tags marcadas com `deleted=true` ainda aparecem na listagem até o sync remover de vez.
</Info>

## Exemplo

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

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/chat/tag/${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/chat/tag/{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/chat/tag/"+os.Getenv("Instance_Name"), nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

`tags` é o array de etiquetas conhecidas pela conta WhatsApp Business; `total` ecoa o tamanho. Cada entrada traz `id` (use em `tags-atribuir`/`tags-desatribuir`/`tags-deletar`), `name`, `color` (0–10) e `type`. Etiquetas marcadas com `deleted: true` representam remoções pendentes de propagação.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Tags retrieved successfully",
  "tags": [
    { "id": "1", "name": "Important", "color": 0, "type": "CUSTOM", "deleted": false },
    { "id": "2", "name": "VIP", "color": 5, "type": "CUSTOM", "deleted": false }
  ],
  "total": 2
}
```

## Parâmetros de rota

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

## Headers

| Nome    | Obrigatório              | Exemplo        | Descrição                      |
| ------- | ------------------------ | -------------- | ------------------------------ |
| `token` | sim (ou `Authorization`) | `a1b2c3d4-...` | TokenAccount ou TokenInstance. |

## Respostas de erro

| HTTP | `error.message`                         | Quando ocorre      |
| ---- | --------------------------------------- | ------------------ |
| 400  | `Instance name is required`             | `:instance` vazio. |
| 401  | `Invalid token`                         | ,                  |
| 404  | `Instance not found`                    | ,                  |
| 503  | `Instance is not connected to WhatsApp` | ,                  |

```json Erro 401 theme={null}
{
  "success": false,
  "error": { "message": "Invalid token" }
}
```

## Relacionados

<CardGroup cols={2}>
  <Card title="Criar etiqueta" href="/pt/api/chat/tags-create">
    `POST /api/chat/tag/:instance`
  </Card>

  <Card title="Atribuir a um chat" href="/pt/api/chat/tags-assign">
    `POST /api/chat/assignTag/:instance`
  </Card>
</CardGroup>