Skip to main content
GET
Lister les emails

Supported products

Autorisations

Authorization
string
header
requis

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

Paramètres de requête

after
string

Le jeton de curseur de pagination de la dernière ressource lue avec succès sera renvoyé en tant que propriété JSON paging.next.after d'une réponse paginée contenant plus de résultats.

archived
boolean

S'il faut renvoyer uniquement les résultats qui ont été archivés.

campaign
string

Filtrer les e-mails par nom de campagne.

createdAfter
string<date-time>

Filtrer les e-mails créés après une date spécifique. Le format doit être date-heure.

createdAt
string<date-time>

Filtrer les e-mails par date de création exacte. Le format doit être date-heure.

createdBefore
string<date-time>

Filtrer les e-mails créés avant une date spécifique. Le format doit être date-heure.

includedProperties
string[]

Spécifiez des propriétés supplémentaires à inclure dans la réponse. Accepte un tableau de chaînes de caractères.

includeStats
boolean

Inclure les statistiques dans la réponse. Accepte une valeur booléenne.

isPublished
boolean

Filtrer les e-mails par leur statut de publication. Accepte une valeur booléenne.

limit
integer<int32>

Le nombre maximum de résultats à afficher par page.

marketingCampaignNames
boolean

Inclure les noms des campagnes marketing dans la réponse. Accepte une valeur booléenne.

publishedAfter
string<date-time>

Filtrer les e-mails publiés après une date spécifique. Le format doit être date-heure.

publishedAt
string<date-time>

Filtrer les e-mails par date de publication exacte. Le format doit être date-heure.

publishedBefore
string<date-time>

Filtrer les e-mails publiés avant une date spécifique. Le format doit être date-heure.

sort
string[]

Spécifier l'ordre de tri des résultats. Accepte un tableau de chaînes de caractères.

type
enum<string>

Filtrer les e-mails par type. Accepte des types d'e-mails spécifiques tels que AB_EMAIL, BATCH_EMAIL, etc.

Options disponibles:
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>

Filtrer les e-mails mis à jour après une date spécifique. Le format doit être date-heure.

updatedAt
string<date-time>

Filtrer les e-mails par la date de mise à jour exacte. Le format doit être date-heure.

updatedBefore
string<date-time>

Filtrer les e-mails mis à jour avant une date spécifique. Le format doit être date-heure.

variantStats
boolean

Inclure les statistiques de variante dans la réponse. Accepte une valeur booléenne.

workflowNames
boolean

Inclure les noms de workflow dans la réponse. Accepte une valeur booléenne.

Réponse

successful operation

results
object[]
requis

Un tableau contenant les objets d'e-mail public récupérés sur la page de résultats actuelle.

total
integer<int32>
requis

Un entier représentant le nombre total d'e-mails publics disponibles.

paging
object

Représente les informations de pagination pour naviguer dans une liste de résultats de l'API. Il fournit des détails sur la manière d'accéder à l'ensemble de résultats précédent ou suivant.

Dernière modification le 6 octobre 2026