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

# Contactos por etiqueta

> Filtra los chats que tienen una o más etiquetas asignadas

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

## Descripción

Devuelve los chats que tienen al menos una de las etiquetas indicadas. Puedes filtrar por **IDs**, por **nombres** (no distingue mayúsculas/minúsculas) o devolver todos los chats que tengan alguna etiqueta.

<Tip>
  Usa `refresh=true` para forzar una sincronización con WhatsApp antes de listar, útil cuando una etiqueta fue cambiada en el teléfono y quieres los datos más recientes.
</Tip>

## Ejemplos

### Por IDs

Filtra los chats que tienen al menos una de las etiquetas listadas en `?labelIds=1,2`. Útil cuando ya conoces los IDs desde [`/tags-list`](/es/api/chat/tags-list).

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

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/chat/contactsByLabel/${process.env.Instance_Name}?labelIds=1,2`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

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

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

### Por nombres (con refresh)

Filtra por nombre vía `?labelNames=VIP,Support` (no distingue mayúsculas/minúsculas) y agrega `refresh=true` para forzar una sincronización con WhatsApp antes de listar, asegurando que los cambios hechos en el teléfono ya sean visibles.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/chat/contactsByLabel/$Instance_Name?labelNames=VIP,Support&refresh=true" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/chat/contactsByLabel/${process.env.Instance_Name}?labelNames=VIP,Support&refresh=true`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

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

  requests.get(
      f"https://ryzeapi.cloud/api/chat/contactsByLabel/{os.environ['Instance_Name']}?labelNames=VIP,Support&refresh=true",
      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/contactsByLabel/"+os.Getenv("Instance_Name")+"?labelNames=VIP,Support&refresh=true", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Todos los que tienen etiquetas

Sin `labelIds` ni `labelNames`, devuelve todos los chats que tienen alguna etiqueta asignada. Útil para auditar el uso general de etiquetas en la cuenta.

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

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

## Respuesta exitosa

`chats` es una lista de objetos `ChatWithLabels` agrupando todas las etiquetas asociadas a cada chat. Usa `total_chats` para la cantidad de chats únicos y `total_rows` para el total de pares chat-etiqueta. `refreshed` indica si la caché fue reconstruida en esta llamada (`refresh=true`); `filter_label_ids` repite los IDs efectivamente aplicados.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Chats by label retrieved successfully",
  "chats": [
    {
      "chat_jid": "5511999999999@s.whatsapp.net",
      "labels": [
        { "id": "1", "name": "Important" }
      ]
    },
    {
      "chat_jid": "5511988887777@s.whatsapp.net",
      "labels": [
        { "id": "1", "name": "Important" },
        { "id": "2", "name": "VIP" }
      ]
    }
  ],
  "total_chats": 2,
  "total_rows": 3,
  "refreshed": false,
  "filter_label_ids": ["1"]
}
```

## Parámetros de ruta

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

## Cabeceras

| Nombre  | Requerido              | Ejemplo        | Descripción                   |
| ------- | ---------------------- | -------------- | ----------------------------- |
| `token` | sí (o `Authorization`) | `a1b2c3d4-...` | TokenAccount o TokenInstance. |

## Parámetros de consulta

<ParamField query="labelIds" type="string">
  IDs de etiquetas separados por coma. Ejemplo: `"1,2,3"`.
</ParamField>

<ParamField query="labelNames" type="string">
  Nombres de etiquetas separados por coma (sin distinguir mayúsculas/minúsculas). Ejemplo: `"VIP,Support"`.
</ParamField>

<ParamField query="refresh" type="boolean" default="false">
  Si es `true`, sincroniza las etiquetas con WhatsApp antes de devolver.
</ParamField>

<Note>
  Sin `labelIds` ni `labelNames`, devuelve **todos** los chats que tienen alguna etiqueta.
</Note>

## Respuestas de error

| HTTP | `error.message`                         | Cuándo ocurre                    |
| ---- | --------------------------------------- | -------------------------------- |
| 400  | `Instance name is required`             | `:instance` vacío.               |
| 401  | `Invalid token`                         | ,                                |
| 404  | `Instance not found`                    | ,                                |
| 503  | `Instance is not connected to WhatsApp` | Requerido cuando `refresh=true`. |

```json Error 400 theme={null}
{
  "success": false,
  "error": { "message": "Instance name is required" }
}
```

## Relacionados

<CardGroup cols={2}>
  <Card title="Listar etiquetas" href="/es/api/chat/tags-list">
    Recupera IDs y nombres para usar en el filtro.
  </Card>

  <Card title="Asignar etiqueta" href="/es/api/chat/tags-assign">
    Agrega una etiqueta a un chat.
  </Card>
</CardGroup>