---
title: "List mail messages associated with a deal"
method: GET
path: "/deals/{id}/mailMessages"
tags: ["Deals"]
---

# List mail messages associated with a deal

`GET /deals/{id}/mailMessages`

Lists mail messages associated with a deal.

## Path parameters

- `id` integer, required

## Query parameters

- `start` integer
- `limit` integer
- `include_body` 0 | 1

## Response `200`

Success

- object
  - `success` boolean — If the response is successful or not
  - `data` object[] — The array of mail messages
    - `object` string — The type of the data item
    - `timestamp` string — The date and time when the item was created
    - `data` object
      - `id` integer — ID of the mail message.
      - `from` object[] — The array of mail message sender (object)
        - `id` integer — ID of the mail participant
        - `email_address` string — Mail address of the mail participant
        - `name` string — Name of the mail participant
        - `linked_person_id` integer — ID of the linked person to the mail message
        - `linked_person_name` string — Name of the linked person to the mail message
        - `mail_message_party_id` integer — ID of the mail message participant
      - `to` object[] — The array of mail message receiver (object)
        - `id` integer — ID of the mail participant
        - `email_address` string — Mail address of the mail participant
        - `name` string — Name of the mail participant
        - `linked_person_id` integer — ID of the linked person to the mail message
        - `linked_person_name` string — Name of the linked person to the mail message
        - `mail_message_party_id` integer — ID of the mail message participant
      - `cc` object[] — The array of mail message copies (object)
        - `id` integer — ID of the mail participant
        - `email_address` string — Mail address of the mail participant
        - `name` string — Name of the mail participant
        - `linked_person_id` integer — ID of the linked person to the mail message
        - `linked_person_name` string — Name of the linked person to the mail message
        - `mail_message_party_id` integer — ID of the mail message participant
      - `bcc` object[] — The array of mail message blind copies (object)
        - `id` integer — ID of the mail participant
        - `email_address` string — Mail address of the mail participant
        - `name` string — Name of the mail participant
        - `linked_person_id` integer — ID of the linked person to the mail message
        - `linked_person_name` string — Name of the linked person to the mail message
        - `mail_message_party_id` integer — ID of the mail message participant
      - `body_url` string — The mail message body URL
      - `body` string — The mail message body content. Only present when `include_body=1` is passed.
      - `account_id` string — The connection account ID
      - `user_id` integer — ID of the user whom mail message will be assigned to
      - `mail_thread_id` integer — ID of the mail message thread
      - `subject` string — The subject of mail message
      - `snippet` string — The snippet of mail message. Snippet length is up to 225 characters.
      - `mail_tracking_status` 'opened' | 'not opened', nullable — The status of tracking mail message. Value is `null` if tracking is not enabled.
      - `mail_link_tracking_enabled_flag` 0 | 1 — Whether the link tracking in mail message body is enabled.
      - `read_flag` 0 | 1 — Whether the mail message is read or not by the user
      - `draft` string — If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise `null`.
      - `draft_flag` 0 | 1 — Whether the mail message is a draft or not
      - `synced_flag` 0 | 1 — Whether the mail message is synced with the provider or not
      - `deleted_flag` 0 | 1 — Whether the mail message is deleted or not
      - `has_body_flag` 0 | 1 — Whether the mail message has a body or not
      - `sent_flag` 0 | 1 — Whether the mail message has been sent or not
      - `sent_from_pipedrive_flag` 0 | 1 — Whether the mail message has been sent from Pipedrive app or not
      - `smart_bcc_flag` 0 | 1 — Whether the mail message has been created by Smart Email BCC feature or not
      - `message_time` string, date-time — Creation or receival time of the mail message
      - `add_time` string, date-time — The insertion into the database time of the mail message
      - `update_time` string, date-time — The updating time in the database of the mail message
      - `has_attachments_flag` 0 | 1 — Whether the mail message has an attachment or not
      - `has_inline_attachments_flag` 0 | 1 — Whether the mail message has an inline attachment or not
      - `has_real_attachments_flag` 0 | 1 — Whether the mail message has an attachment (which is not inline) or not
      - `nylas_id` string — The Mail Message ID assigned by the sync provider
      - `s3_bucket` string — The name of the S3 bucket
      - `s3_bucket_path` string — The path of the S3 bucket
      - `external_deleted_flag` boolean — If the Mail Message has been deleted on the provider side or not
      - `mua_message_id` string — The Mail Message ID assigned by the mail user agent
      - `template_id` integer — The ID of the mail template
      - `timestamp` string — The add date and time of the Mail Message
      - `item_type` string — The type of the data item
      - `company_id` integer — The ID of the company
  - `additional_data` object — The additional data of the list
    - `start` integer — Pagination start
    - `limit` integer — Items shown per page
    - `more_items_in_collection` boolean — If there are more list items in the collection than displayed or not

---

[API](https://skmtc.net/pipedrive/apis/pipedrive-api-v1.md) · [All operations](https://skmtc.net/pipedrive/apis/pipedrive-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipedrive/pipedrive-api-v1/versions/bf863a979545/schema)