v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Email

List emails

Returns a list of emails

get/emails

Query parameters

subjectstring

Filter emails by subject using case-insensitive partial matching

crm_account_idstring[]

Filter emails by CRM account id

deal_uuidstring[]

Filter emails by deal uuid

from_date_timestring date-time

Start date and time for filtering emails (ISO 8601 format)

to_date_timestring date-time

End date and time for filtering emails (ISO 8601 format)

pageinteger

Page number for pagination (starts from 1)

sizeinteger

Number of items per page (min 1, max 50)

Response

emails successfully returned

Example response

{
  "data": [
    {
      "messageId": "123e4567-e89b-12d3-a456-426614174000",
      "threadId": "thread_789f0123-g45h-67i8-j901-234567890123",
      "sendDate": "2024-03-15T14:30:00Z",
      "sender": "john.doe@company.com",
      "recipients": [
        "jane.smith@company.com",
        "bob.johnson@company.com"
      ],
      "ccRecipients": [
        "manager@company.com",
        "team@company.com"
      ],
      "subject": "Project Update - Q1 2024 Report",
      "snippet": "Hi team, I wanted to share the latest updates on our Q1 project...",
      "bodyUrl": "https://api.company.com/emails/123e4567-e89b-12d3-a456-426614174000/body",
      "isInternalUser": false
    }
  ],
  "meta": {
    "pageCount": 5,
    "totalRecords": 100,
    "pageNumber": 1,
    "pageSize": 20
  }
}