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

# List WhatsApp messages

> Shows WhatsApp messages you sent. Filter by date, status, or type.



## OpenAPI

````yaml /en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages
openapi: 3.0.3
info:
  title: Notifique API — WhatsApp
  description: >-
    Send WhatsApp messages and manage connections. Authenticate with
    `Authorization: Bearer sk_live_...` or `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Production
security:
  - ntfWaBearerAuth: []
  - ntfWaApiKeyHeader: []
tags:
  - name: Messages
    description: Send, list, edit, and cancel messages
  - name: Instances
    description: >-
      Register and manage connected WhatsApp numbers — each number is an
      **instance** (the phone that sends and receives messages).
  - name: Groups
    description: Groups (unofficial only)
paths:
  /v1/whatsapp/messages:
    get:
      tags:
        - Mensagens
      summary: List WhatsApp messages
      description: Shows WhatsApp messages you sent. Filter by date, status, or type.
      operationId: ntfWa_getV1WhatsappMessages
      parameters:
        - name: page
          in: query
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: string
        - name: fromDate
          in: query
          schema:
            type: string
            format: date-time
        - name: toDate
          in: query
          schema:
            type: string
            format: date-time
        - name: instanceIds
          in: query
          schema:
            type: string
            description: IDs separados por vírgula
        - name: status
          in: query
          schema:
            type: string
            enum:
              - QUEUED
              - PROCESSING
              - SENT
              - DELIVERED
              - READ
              - FAILED
              - CANCELLED
              - SCHEDULED
              - DELETED
              - RESPONDED
              - EDITED
        - name: type
          in: query
          description: >-
            Filtra por tipo de message no histórico. **TEMPLATE** é tipo
            armazenado para modelos específicos; demais tipos refletem o que foi
            enviado pela API.
          schema:
            type: string
            enum:
              - TEXT
              - IMAGE
              - DOCUMENT
              - AUDIO
              - VIDEO
              - BUTTONS
              - LIST
              - TEMPLATE
              - LOCATION
              - CONTACT
        - name: includeEvents
          in: query
          schema:
            type: string
            description: true/1/yes para incluir eventos
      responses:
        '200':
          description: List de mensagens e pagination.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      type: object
                  pagination:
                    type: object
                    properties:
                      total:
                        type: integer
                      page:
                        type: integer
                      limit:
                        type: integer
                      totalPages:
                        type: integer
              example:
                success: true
                data:
                  - messageId: clxx123...
                    to: '5511999999999'
                    type: TEXT
                    status: SENT
                    sentAt: '2025-02-20T12:00:00.000Z'
                    deliveredAt: '2025-02-20T12:00:05.000Z'
                    createdAt: '2025-02-20T11:59:58.000Z'
                pagination:
                  total: 42
                  page: 1
                  limit: 20
                  totalPages: 3
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '402':
          description: Plano expirado ou suspenso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '403':
          description: Escopo ou acesso à instance negado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
components:
  schemas:
    NtfWa_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Message legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Responses de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        note:
          type: string
      required:
        - success
        - error
        - message
        - code
  securitySchemes:
    ntfWaBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfWaApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key no header x-api-key.

````