---
title: "Retorna uma lista de mensagens."
method: GET
path: "/v1/messages"
tags: ["messages"]
---

# Retorna uma lista de mensagens.

`GET /v1/messages`

## Request

- Base URL: `//app.vindi.com.br/api` (relative, and the document’s source URL is not known)
- URL: `//app.vindi.com.br/api/v1/messages`
- Auth: HTTP basic

Utilize este método para listar as mensagens enviadas através da sua conta na plataforma Vindi. Leia a documentação sobre [paginação](http://atendimento.vindi.com.br/hc/pt-br/articles/203020644#pagination) e [filtros de busca](http://atendimento.vindi.com.br/hc/pt-br/articles/204163150).

#### Atributos para busca
<code>id</code>, <code>notification_type</code>, <code>notification_id</code>, <code>seen_at</code>, <code>customer_id</code>, <code>charge_id</code> e <code>created_at</code>.

## Query parameters

- `page` integer
- `per_page` integer
- `query` string
- `sort_by` 'id' | 'notification_type' | 'notification_id' | 'seen_at' | 'customer_id' | 'charge_id' | 'created_at'
- `sort_order` 'asc' | 'desc'

## Response `200`

Consulta realizada com sucesso.

- Message[]
  - `id` integer, required: ID da mensagem
  - `notification_type` 'email' | 'sms', required: Tipo da notificação da mensagem
  - `seen_at` string: Última visualização da mensagem
  - `created_at` string, required: Data e hora do envio da mensagem
  - `customer` CustomerSummary, required
    - `id` integer, required: ID do cliente
    - `name` string, required: Nome do cliente
    - `email` string: E-mail do cliente
    - `code` string: Código opcional para referência via API
  - `charge` ChargeSummary, required
    - `id` integer, required: ID da cobrança
  - `notification` NotificationSummary, required
    - `id` integer, required: Id
    - `notification_type` string, required: Método de envio

## Other responses

- `400`: Erro de sintaxe JSON no corpo do request.
- `422`: Parâmetros inválidos. Verificar erro na resposta.

---

[API](https://skmtc.dev/vindi/apis/api-vindi.md) - [All operations](https://skmtc.dev/vindi/apis/api-vindi/llms.txt) - [OpenAPI document](https://skmtc.dev/vindi/apis/api-vindi/revisions/3e857e1cdd03?raw)