Pular para o conteúdo principal
GET
/
api
/
chat
/
tag
/
:instance
Listar etiquetas
curl --request GET \
  --url https://api.example.com/api/chat/tag/:instance
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.
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.

​
Exemplo

curl -X GET "https://ryzeapi.cloud/api/chat/tag/$Instance_Name" \
  -H "token: $Token_Instance"

​
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.
200 OK
{
  "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

​
instance
string
obrigatório
Nome da instância.

​
Headers

NomeObrigatórioExemploDescrição
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required:instance vazio.
401Invalid token,
404Instance not found,
503Instance is not connected to WhatsApp,
Erro 401
{
  "success": false,
  "error": { "message": "Invalid token" }
}

​
Relacionados

Criar etiqueta

POST /api/chat/tag/:instance

Atribuir a um chat

POST /api/chat/assignTag/:instance