Skip to main content
GET
Listar mensagens e-mail

Autorizações

Authorization
string
header
obrigatório

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Parâmetros de consulta

page
string

Página (padrão 1).

limit
string

Itens por página (padrão 20, máx. 100).

fromDate
string<date-time>

Início do intervalo (filtro em createdAt, inclusive).

toDate
string<date-time>

Fim do intervalo (filtro em createdAt, inclusive).

status
string

Um ou mais status separados por vírgula: QUEUED, SCHEDULED, PROCESSING, SENT, DELIVERED, OPENED, CLICKED, FAILED, CANCELLED, COMPLAINED. Valores inválidos são ignorados.

emailDomainId
string

Filtra pelo ID (cuid) do domínio de envio; deve pertencer ao workspace. Alternativa: email_domain_id.

email_domain_id
string

Alias de emailDomainId.

Resposta

Lista de e-mails e paginação.

success
boolean
obrigatório
Exemplo:

true

data
object[]
obrigatório

Cada item tem os mesmos campos que GET /v1/email/messages/{id} em data. Não inclui corpo (html/text), emailDomainId, externalId nem providerUsed.

pagination
object
obrigatório