Back to Pipedrive OauthGet mail threads
Returns mail threads in a specified folder ordered by the most recent message within.
Input
type: object
properties:
parameters:
type: object
properties:
folder:
type: string
enum:
- inbox
- drafts
- sent
- archive
default: inbox
description: The type of folder to fetch
start:
type: integer
default: 0
description: Pagination start
limit:
type: integer
description: Items shown per page
required:
- folder
Output
title: getMailThreadsResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
type: array
description: The array of mail threads
items:
title: baseMailThread
type: object
properties:
id:
type: integer
description: ID of the mail thread
account_id:
type: string
description: The connection account ID
user_id:
type: integer
description: ID of the user whom mail message will be assigned to
subject:
type: string
description: The subject
snippet:
type: string
description: A snippet
read_flag:
description: Whether the mail thread is read
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
mail_tracking_status:
type: string
nullable: true
description: Mail tracking status
has_attachments_flag:
description: Whether the mail thread has an attachment
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
has_inline_attachments_flag:
description: Whether the mail thread has inline attachments
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
has_real_attachments_flag:
description: Whether the mail thread has real attachments (which are not inline)
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
deleted_flag:
description: Whether the mail thread is deleted
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
synced_flag:
description: Whether the mail thread is synced
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
smart_bcc_flag:
description: Whether one of the parties of the mail thread is Bcc
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
mail_link_tracking_enabled_flag:
description: Whether the link tracking of the mail thread is enabled
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
parties:
type: object
description: Parties of the mail thread
properties:
to:
type: array
description: Recipients of the mail thread
items:
type: object
description: Member of a thread
properties:
id:
type: integer
description: ID of the mail thread participant
name:
type: string
description: Name of the mail thread participant
latest_sent:
type: boolean
description: >-
Whether the mail thread participant was last to send an
email
email_address:
type: string
description: Email address of the mail thread participant
message_time:
type: number
description: Message time
linked_person_id:
type: integer
description: ID of the linked person
linked_person_name:
type: string
description: Email of the linked person
mail_message_party_id:
type: integer
description: ID of the mail message party
linked_organization_id:
type: integer
nullable: true
description: Linked Organization ID
from:
type: array
description: Senders of the mail thread
items:
type: object
description: Member of a thread
properties:
id:
type: integer
description: ID of the mail thread participant
name:
type: string
description: Name of the mail thread participant
latest_sent:
type: boolean
description: >-
Whether the mail thread participant was last to send an
email
email_address:
type: string
description: Email address of the mail thread participant
message_time:
type: number
description: Message time
linked_person_id:
type: integer
description: ID of the linked person
linked_person_name:
type: string
description: Email of the linked person
mail_message_party_id:
type: integer
description: ID of the mail message party
linked_organization_id:
type: integer
nullable: true
description: Linked Organization ID
drafts_parties:
type: array
description: Parties of the drafted mail thread
items:
type: object
folders:
type: array
description: Folders in which messages from thread are being stored
items:
type: string
version:
type: number
description: Version
snippet_draft:
type: string
nullable: true
description: A snippet from a draft
snippet_sent:
type: string
description: A snippet from a message sent
message_count:
type: integer
description: An amount of messages
has_draft_flag:
type: number
description: Whether the mail thread has any drafts
title: numberBooleanDefault0
default: 0
enum:
- 0
- 1
has_sent_flag:
type: number
description: Whether the mail thread has messages sent
title: numberBooleanDefault0
default: 0
enum:
- 0
- 1
archived_flag:
description: Whether the mail thread is archived
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
shared_flag:
description: Whether the mail thread is shared
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
external_deleted_flag:
description: Whether the mail thread has been deleted externally
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
first_message_to_me_flag:
description: Whether the mail thread was initialized by others
title: numberBooleanDefault0
type: number
default: 0
enum:
- 0
- 1
last_message_timestamp:
type: string
format: date-time
description: Last message timestamp
first_message_timestamp:
type: string
format: date-time
description: >-
The time when the mail thread has had the first message received or
created
last_message_sent_timestamp:
type: string
format: date-time
nullable: true
description: The last time when the mail thread has had a message sent
last_message_received_timestamp:
type: string
format: date-time
description: The last time when the mail thread has had a message received
add_time:
type: string
format: date-time
description: The time when the mail thread was inserted to database
update_time:
type: string
format: date-time
description: The time when the mail thread was updated in database received
deal_id:
type: integer
nullable: true
description: The ID of the deal
deal_status:
type: string
nullable: true
description: Status of the deal
lead_id:
type: string
format: uuid
nullable: true
description: The ID of the lead
all_messages_sent_flag:
type: number
description: Whether all the mail thread messages have been sent
title: numberBooleanDefault0
default: 0
enum:
- 0
- 1