Emails

Emails synced from external providers (Gmail, Outlook) and linked to deals, contacts, projects, or tasks. They surface client communication history directly within Productive for CRM context.

List and retrieve email threads associated with records through these endpoints.

Attributes

after string
Parameter `filter`

Filter emails created after this date.

attachments array of attachment
Response

The file attachments associated with this email.

auto_linked boolean
Response

Whether this email was automatically linked to a deal or resource by the system.

bcc_recipients array of person
Response

The BCC recipients of this email.

before string
Parameter `filter`

Filter emails created before this date.

body object
Response

The plain text body of this email.

body_html object
Response

The raw HTML body of this email, available when the email inbox feature is enabled.

body_truncated object
Response

A truncated version of the plain text body, used for preview purposes.

cc_recipients array of person
Response

The CC recipients of this email.

company_id integer
Parameter `filter`

Filter to return emails associated with a specific company, matched via recipients, deals, or invoices.

created_at string
Response

Timestamp when this email record was created in Productive.

creator person
Response

The person who created or sent this email.

creator_id integer
Parameter `filter`

ID of the person who created or sent this email.

deal deal
Response

The deal or quote this email is linked to.

delivered_at string
Response

Timestamp when this email was successfully delivered, or null if not yet delivered.

dismissed_at string
Response

Timestamp when this email was dismissed from the inbox, or null if it has not been dismissed.

external_id string
Response

The external identifier of this email from the originating email provider.

failed_at string
Response

Timestamp when delivery of this email failed, or null if no failure occurred.

from string
Response

The sender's email address.

id integer
Parameter `filter`

The unique identifier of this email.

integration integration
Response

The email integration (inbox connection) through which this email was synced.

invoice invoice
Response

The invoice this email is linked to.

linked_id integer
Response

The ID of the polymorphic resource this email is linked to (deal, invoice, workspace, etc.).

linked_type string
Response

The type of resource this email is linked to (e.g. Quote, Invoice, Workspace).

organization organization
Response

The organization this email belongs to.

outgoing boolean
Response

Whether this email was sent outgoing from Productive, as opposed to an incoming received email.

participants array of person
Response

The people who participated in this email thread as senders or recipients.

payment_reminder payment reminder
Response

The payment reminder this email is associated with.

received_at string
Response

Timestamp when this email was received from the external provider.

recipient_id integer
Parameter `filter`

Filter to return emails where this person is a recipient.

recipients array of person
Response

A grouped map of recipients by type (to, cc, bcc), each with address, person ID, and delivery status.

sender_or_recipient_id integer
Parameter `filter`

The sender or recipient id.

snippet string
Response

A short preview snippet of the email content.

status integer
Parameter `filter` Enum

The inbox status of this email: unresolved (1), resolved/linked (2), or dismissed (3).

Enum Values (3 values)

  • 1
  • 2
  • 3
subject string
Response

The subject line of this email.

thread object
Response

The email inbox thread this email belongs to.

to_recipients array of person
Response

The primary (To:) recipients of this email.

unread boolean
Response

Whether this email has been marked as unread.