> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtener lista de chats

> Recuperar una lista de conversaciones de chat con su información básica



## OpenAPI

````yaml /es/openapi.yml get /chats
openapi: 3.0.0
info:
  title: Multidispositivo API de WhatsApp
  version: 9.7.0
  description: >
    Esta API se utiliza para enviar whatsapp a través de API.


    El panel web es un proyecto separado (gowa-ui); el servidor descarga su
    último recurso de versión

    y lo sirve en `/` (o devuelve un banner JSON cuando

    APP_UI_ENABLED=false).


    Ámbito del dispositivo:

    - Envía `X-Device-Id` en todas las llamadas REST con ámbito dispositivo.

    - WebSocket: conectar a `/ws?device_id=<id>`.

    - WebSocket auth (cuando la autenticación básica está habilitada): los
    navegadores no pueden establecer un encabezado
      de autorización en conexiones WebSocket, así que también pase
      `&authorization=<base64(user:pass)>` en la cadena de consulta. Usa TLS en producciónformat@@0
      ya que la credencial es visible en la URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Conexión inicial al servidor de Whatsapp
  - name: device
    description: Gestión de dispositivos para soporte multidispositivo
  - name: user
    description: Obteniendo información
  - name: send
    description: Enviar mensaje (Texto/Imágen/Archivo/Video).
  - name: message
    description: Manipulación de mensajes (revocar/react/actualizar).
  - name: call
    description: Gestión de llamadas (rechazar llamadas entrantes)
  - name: chat
    description: Chats de chat y mensajería
  - name: group
    description: Ajuste de grupo
  - name: newsletter
    description: configuración del boletín de noticias
  - name: chatwoot
    description: Integración de Chatwoot para soporte al cliente
paths:
  /chats:
    get:
      tags:
        - chat
      summary: Obtener lista de chats
      description: Recuperar una lista de conversaciones de chat con su información básica
      operationId: listChats
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
        - name: limit
          in: query
          schema:
            type: integer
            default: 25
            maximum: 100
          description: Número máximo de chats a devolver
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
          description: Número de chats a omitir (para paginación)
        - name: search
          in: query
          schema:
            type: string
          description: Buscar chats por nombre
        - name: has_media
          in: query
          schema:
            type: boolean
            default: false
          description: Filtrar chats que contienen mensajes multimedia
        - name: archived
          in: query
          schema:
            type: boolean
          description: >-
            Filtrar por estado archivado. true = archivado solamente, false = no
            archivado solamente. Omitir para devolver todos los chats.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatListResponse'
        '400':
          description: Solicitud incorrecta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: No autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: >
        Identificador de dispositivo para soporte multidispositivo. Requerido
        cuando se registran múltiples dispositivos.

        Si sólo se registra un dispositivo, se utilizará como el valor
        predeterminado.

        También se puede proporcionar como parámetro de consulta `device_id`.
      schema:
        type: string
        example: my-device-id
  schemas:
    ChatListResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Success get chat list
        results:
          type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Chat'
            pagination:
              type: object
              properties:
                limit:
                  type: integer
                  example: 25
                offset:
                  type: integer
                  example: 0
                total:
                  type: integer
                  example: 150
    ErrorBadRequest:
      type: object
      properties:
        code:
          type: string
          example: 400
          description: Código de estado HTTP
        message:
          type: string
          example: field cannot be blank
          description: Mensaje de error detallado
        results:
          type: object
          example: null
          description: datos adicionales
    ErrorUnauthorized:
      type: object
      properties:
        code:
          type: string
          example: 401
          description: Código de estado HTTP
        message:
          type: string
          example: Unauthorized access
          description: Mensaje de error detallado
        results:
          type: object
          example: null
          description: datos adicionales
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: Error
        message:
          type: string
          example: you are not loggin
          description: Mensaje de error detallado
        results:
          type: object
          example: null
          description: datos adicionales
    Chat:
      type: object
      properties:
        jid:
          type: string
          example: 6289685028129@s.whatsapp.net
          description: Identificador JID de chat
        name:
          type: string
          example: John Doe
          description: Nombre de pantalla del chat
        last_message_time:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
          description: Marca de tiempo del último mensaje
        ephemeral_expiration:
          type: integer
          example: 0
          description: >-
            Tiempo de expiración del mensaje efemeral en segundos (0 =
            deshabilitado)
        created_at:
          type: string
          format: date-time
          example: '2024-01-10T08:00:00Z'
          description: Marca de tiempo de creación de chat
        updated_at:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
          description: Última actualización del chat
        archived:
          type: boolean
          example: false
          description: Si el chat está archivado
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [Obtener lista de contactos de usuario](https://gowa-docs.mintlify.site/es/api-reference/user/obtener-lista-de-contactos-de-usuario.md)
- [Obtener lista de dispositivos conectados](https://gowa-docs.mintlify.site/es/api-reference/app/obtener-lista-de-dispositivos-conectados.md)
- [Obtener mensajes de un chat específico](https://gowa-docs.mintlify.site/es/api-reference/chat/obtener-mensajes-de-un-chat-específico.md)
- [Obtener lista de participantes en un grupo](https://gowa-docs.mintlify.site/es/api-reference/group/obtener-lista-de-participantes-en-un-grupo.md)
- [Obtener lista de solicitudes de participantes para unirse al grupo](https://gowa-docs.mintlify.site/es/api-reference/group/obtener-lista-de-solicitudes-de-participantes-para-unirse-al-grupo.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.