Pular para o conteúdo principal
GET
Listar e-mails

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de consulta

after
string

O token do cursor de paginação do último recurso lido será retornado como a propriedade JSON paging.next.after de uma resposta paginada que contém mais resultados.

archived
boolean

Se apenas os resultados que foram arquivados devem ser retornados.

campaign
string

Filtrar e-mails por nome da campanha.

createdAfter
string<date-time>

Filtrar e-mails criados após uma data específica. O formato deve ser data-hora.

createdAt
string<date-time>

Filtrar e-mails pela data exata de criação. O formato deve ser data-hora.

createdBefore
string<date-time>

Filtrar e-mails criados antes de uma data específica. O formato deve ser data-hora.

includedProperties
string[]

Especifique propriedades adicionais para incluir na resposta. Aceita um array de strings.

includeStats
boolean

Incluir estatísticas na resposta. Aceita um valor booleano.

isPublished
boolean

Filtra e-mails pelo status de publicação. Aceita um valor booleano.

limit
integer<int32>

O número máximo de resultados a serem exibidos por página.

marketingCampaignNames
boolean

Inclui nomes de campanhas de marketing na resposta. Aceita um valor booleano.

publishedAfter
string<date-time>

Filtre e-mails publicados após uma data específica. O formato deve ser data e hora.

publishedAt
string<date-time>

Filtrar e-mails pela data exata de publicação. O formato deve ser data-hora.

publishedBefore
string<date-time>

Filtrar e-mails publicados antes de uma data específica. O formato deve ser data-hora.

sort
string[]

Especifique a ordem de classificação dos resultados. Aceita um array de strings.

type
enum<string>

Filtre e-mails por tipo. Aceita tipos de e-mail específicos, como AB_EMAIL, BATCH_EMAIL, etc.

Opções disponíveis:
AB_EMAIL,
AUTOMATED_AB_EMAIL,
AUTOMATED_EMAIL,
BATCH_EMAIL,
BLOG_EMAIL,
BLOG_EMAIL_CHILD,
FEEDBACK_CES_EMAIL,
FEEDBACK_CUSTOM_EMAIL,
FEEDBACK_CUSTOM_SURVEY_EMAIL,
FEEDBACK_NPS_EMAIL,
FOLLOWUP_EMAIL,
LEADFLOW_EMAIL,
LOCALTIME_EMAIL,
MANAGE_PREFERENCES_EMAIL,
MARKETING_SINGLE_SEND_API,
MEMBERSHIP_EMAIL_VERIFICATION_EMAIL,
MEMBERSHIP_FOLLOW_UP_EMAIL,
MEMBERSHIP_OTP_LOGIN_EMAIL,
MEMBERSHIP_PASSWORD_RESET_EMAIL,
MEMBERSHIP_PASSWORD_SAVED_EMAIL,
MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL,
MEMBERSHIP_REGISTRATION_EMAIL,
MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL,
MEMBERSHIP_VERIFICATION_EMAIL,
OPTIN_EMAIL,
OPTIN_FOLLOWUP_EMAIL,
RESUBSCRIBE_EMAIL,
RSS_EMAIL,
RSS_EMAIL_CHILD,
SINGLE_SEND_API,
SMTP_TOKEN,
TICKET_EMAIL
updatedAfter
string<date-time>

Filtrar e-mails atualizados após uma data específica. O formato deve ser data-hora.

updatedAt
string<date-time>

Filtre os e-mails pela data exata de atualização. O formato deve ser data-hora.

updatedBefore
string<date-time>

Filtrar e-mails atualizados antes de uma data específica. O formato deve ser data-hora.

variantStats
boolean

Inclui estatísticas de variantes na resposta. Aceita um valor booleano.

workflowNames
boolean

Inclui nomes de fluxos de trabalho na resposta. Aceita um valor booleano.

Resposta

successful operation

results
object[]
obrigatório

Uma matriz que contém os objetos de e-mail públicos recuperados na página atual de resultados.

total
integer<int32>
obrigatório

Um número inteiro que representa o número total de e-mails públicos disponíveis.

paging
object

Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados.

Última modificação em 6 de outubro de 2026