Retrieve emails
Recupere uma lista de e-mails de marketing da sua conta da HubSpot. Este endpoint permite filtrar e-mails com base em vários critérios, como data de publicação, data de criação, data de atualização e muito mais. Você também pode controlar o número de resultados por página e incluir estatísticas ou propriedades adicionais na resposta.
Supported products
Supported products
Required Scopes
Required Scopes
Autorizações
The access token received from the authorization server in the OAuth 2.0 flow.
Parâmetros de consulta
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.
Se apenas os resultados que foram arquivados devem ser retornados.
Filtrar e-mails por nome da campanha.
Filtrar e-mails criados após uma data específica. O formato deve ser data-hora.
Filtrar e-mails pela data exata de criação. O formato deve ser data-hora.
Filtrar e-mails criados antes de uma data específica. O formato deve ser data-hora.
Especifique propriedades adicionais para incluir na resposta. Aceita um array de strings.
Incluir estatísticas na resposta. Aceita um valor booleano.
Filtra e-mails pelo status de publicação. Aceita um valor booleano.
O número máximo de resultados a serem exibidos por página.
Inclui nomes de campanhas de marketing na resposta. Aceita um valor booleano.
Filtre e-mails publicados após uma data específica. O formato deve ser data e hora.
Filtrar e-mails pela data exata de publicação. O formato deve ser data-hora.
Filtrar e-mails publicados antes de uma data específica. O formato deve ser data-hora.
Especifique a ordem de classificação dos resultados. Aceita um array de strings.
Filtre e-mails por tipo. Aceita tipos de e-mail específicos, como AB_EMAIL, BATCH_EMAIL, etc.
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 Filtrar e-mails atualizados após uma data específica. O formato deve ser data-hora.
Filtre os e-mails pela data exata de atualização. O formato deve ser data-hora.
Filtrar e-mails atualizados antes de uma data específica. O formato deve ser data-hora.
Inclui estatísticas de variantes na resposta. Aceita um valor booleano.
Inclui nomes de fluxos de trabalho na resposta. Aceita um valor booleano.
Resposta
successful operation
Uma matriz que contém os objetos de e-mail públicos recuperados na página atual de resultados.
Um número inteiro que representa o número total de e-mails públicos disponíveis.
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.