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

# Listar conversas

> Lista conversas e grupos conhecidos pela instância.

Lista conversas e grupos conhecidos pela instância.

<Note>Aliases consolidados da collection: `Pegar chats`.</Note>


## OpenAPI

````yaml GET /instances/{instanceId}/token/{instanceToken}/chats
openapi: 3.0.3
info:
  title: EZ API
  version: 1.0.0
  description: >-
    Documentação pública reconstruída a partir da collection WA Gateway e
    validada contra os endpoints públicos existentes da EZ API.
servers:
  - url: https://api.ezapi.com.br
    description: Produção
  - url: http://localhost:3000
    description: Desenvolvimento local
security:
  - ClientToken: []
tags:
  - name: Instância
    description: >-
      Crie, conecte, monitore e ajuste o comportamento da sua instância do
      WhatsApp.
  - name: Mensagens
    description: >-
      Envie mensagens assíncronas em texto, mídia, interativos e recursos
      avançados.
  - name: Conversas
    description: Endpoints de conversas.
  - name: Contatos
    description: Endpoints de contatos.
  - name: Privacidade
    description: Endpoints de privacidade.
  - name: Grupos
    description: >-
      Crie grupos, gerencie participantes, convites, foto, descrição e
      permissões.
  - name: Status
    description: Endpoints de status.
  - name: Fila de mensagens
    description: Endpoints de fila de mensagens.
  - name: WhatsApp Business
    description: Endpoints de whatsapp business.
  - name: Webhooks
    description: Configure URLs HTTPS para receber eventos em tempo real da EZ API.
paths:
  /instances/{instanceId}/token/{instanceToken}/chats:
    get:
      tags:
        - Conversas
      summary: Listar conversas
      description: Lista conversas e grupos conhecidos pela instância.
      operationId: chats_list
      parameters:
        - name: instanceId
          in: path
          required: true
          description: Identificador único da instância.
          schema:
            type: string
            example: abc1234567890
        - name: instanceToken
          in: path
          required: true
          description: Token privado da instância retornado na criação.
          schema:
            type: string
            example: tok_a1b2c3d4e5f6
        - name: page
          in: query
          required: false
          description: >-
            Utilizado para paginação você de informar aqui a pagina de chats que
            quer buscar
          schema:
            type: integer
            example: 1
        - name: pageSize
          in: query
          required: false
          description: Especifica o tamanho do retorno de chats por pagina
          schema:
            type: integer
            example: 20
      responses:
        '200':
          description: Resposta de sucesso.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    isGroup:
                      type: boolean
                      example: false
                    name:
                      type: string
                      example: Maria Silva
                    phone:
                      type: string
                      example: '5511999999999'
                    unread:
                      type: string
                      example: '0'
                    lastMessageTime:
                      type: integer
                      example: 1736200000
                    isMuted:
                      type: string
                      example: '0'
                    isMarkedSpam:
                      type: boolean
                      example: false
                    archived:
                      type: boolean
                      example: false
                    pinned:
                      type: boolean
                      example: false
                    muteEndTime:
                      nullable: true
                    messagesUnread:
                      type: integer
                      example: 0
                  required:
                    - isGroup
                    - name
                    - phone
                    - unread
                    - lastMessageTime
                    - isMuted
                    - isMarkedSpam
                    - archived
                    - pinned
                    - muteEndTime
                    - messagesUnread
                  example:
                    isGroup: false
                    name: Maria Silva
                    phone: '5511999999999'
                    unread: '0'
                    lastMessageTime: 1736200000
                    isMuted: '0'
                    isMarkedSpam: false
                    archived: false
                    pinned: false
                    muteEndTime: null
                    messagesUnread: 0
                example:
                  - isGroup: false
                    name: Maria Silva
                    phone: '5511999999999'
                    unread: '0'
                    lastMessageTime: 1736200000
                    isMuted: '0'
                    isMarkedSpam: false
                    archived: false
                    pinned: false
                    muteEndTime: null
                    messagesUnread: 0
              example:
                - isGroup: false
                  name: Maria Silva
                  phone: '5511999999999'
                  unread: '0'
                  lastMessageTime: 1736200000
                  isMuted: '0'
                  isMarkedSpam: false
                  archived: false
                  pinned: false
                  muteEndTime: null
                  messagesUnread: 0
        '401':
          description: Client-Token ou instanceToken inválido
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unauthorized
                message: Invalid instanceToken
        '404':
          description: Instância ou recurso não encontrado
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Instance not found
        '408':
          description: Timeout do worker
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Worker command timeout
        '422':
          description: Falha ao processar a ação
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unable to process request
      security:
        - ClientToken: []
components:
  securitySchemes:
    ClientToken:
      type: apiKey
      in: header
      name: Client-Token

````