---
title: "Retorna uma lista de notificações."
method: GET
path: "/v1/notifications"
tags: ["notifications"]
---

# Retorna uma lista de notificações.

`GET /v1/notifications`

## 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/notifications`
- Auth: HTTP basic

Utilize este método para listar as notificações associadas à sua conta na 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>.

## Query parameters

- `page` integer
- `per_page` integer
- `query` string
- `sort_by` 'id'
- `sort_order` 'asc' | 'desc'

## Response `200`

Consulta realizada com sucesso.

- Notification[]
  - `id` integer, required: Id
  - `status` string, required: Status
  - `notification_type` string, required: Método de envio
  - `name` string, required: Nome
  - `subject` string: Assunto
  - `content` string, required: Conteúdo
  - `trigger_type` string, required: Tipo de disparo
  - `trigger_day` integer, required: Dia para disparo
  - `bcc` string: Cópia oculta
  - `created_at` string, required: Criação
  - `updated_at` string, required: Atualização

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