v1
latestOpenAPI 3.1.02026-07-242200814.7 KBListar e-mails
get/emails
Query parameters
showinteger
Número de itens na página de resultado.
cursorstring
Número da página.
user_idinteger
Filtrar pelo ID do usuário vinculado ao e-mail.
company_idinteger
Filtrar pelo ID da empresa.
person_idinteger
Filtrar pelo ID de pessoa.
deal_idinteger
Filtrar pelo ID de oportunidade.
email_template_idinteger
Filtrar pelo ID do template de email.
statusinteger
Filtrar pelo status do email. Opções: 1= Não lido | 2= Lido | 3= Enviado | 4= Falha ao enviar
typeinteger
Filtrar pelo tipo do email. Opções: 0= Recebido | 1= Enviado | 2= Rascunho | 3= Arquivado
created_at_startstring date-time
Filtrar e-mails criados a partir da data e hora informada.
created_at_endstring date-time
Filtrar e-mails criados até a data e hora informada.
updated_at_startstring date-time
Filtrar e-mails criados a partir da data e hora informada.
updated_at_endstring date-time
Filtrar e-mails atualizados a partir da data e hora informada.
Response
200
Example response
{
"success": true,
"message": "OK",
"data": [
{
"id": 123,
"account_id": 123,
"user_id": 123,
"email_id": 123,
"deal_id": 123,
"company_id": 123,
"person_id": 123,
"proposal_id": 123,
"email_template_id": 123,
"sender": "teste@email.com",
"sender_name": "teste@email.com",
"to": "teste2@email.com",
"to_name": "Usuário",
"reply_to": "teste@email.com",
"cco": "12345@piperunmail.com.br",
"subject": "Reunião {Sua empresa} x",
"sent_at": "2022-09-15 18:28:56",
"status": 1,
"hash": "632399.....137",
"type": 1,
"created_at": "2022-09-15 18:28:57",
"bodyFile": "https://....k0s4ogk4o4w.html"
}
],
"meta": {
"cursor": {
"next": "eyJpZCI6M...cyI6dHJ1ZX0"
}
}
}