Skip to main content
GET
List email messages

Authorizations

Authorization
string
header
required

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

Query Parameters

page
string

Page (default 1).

limit
string

Items per page (default 20, max 100).

fromDate
string<date-time>

Start of date range (filters createdAt, inclusive).

toDate
string<date-time>

End of date range (filters 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.

Response

Lista de e-mails e paginação.

success
boolean
required
Example:

true

data
object[]
required

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
required