v1

latestOpenAPI 3.1.02026-07-14159142161.9 KB

emailService

Retrieve Email by ID

Retrieves a specific email by its ID. Available only for mailbox owner or users with email role setter.

get/email/v1/emails/{emailId}

Path parameters

emailIdinteger required

Example:10

The ID of the email

Response

idinteger

added_byinteger

auth_user_idinteger

imap_hoststring

imap_portinteger

smtp_hoststring nullable

smtp_portinteger nullable

emailstring

namestring

sender_namestring

access_level'shared' | 'personal'

status'pending_settings' | 'first_sync' | 'connected' | 'auth_fail'

created_atinteger

updated_atinteger

oauth_providerstring nullable

crm_integration_enabledboolean

Example response

{
  "id": 2,
  "added_by": 1,
  "auth_user_id": 557,
  "imap_host": "imap.gmail.com",
  "imap_port": 993,
  "smtp_host": "smtp.gmail.com",
  "smtp_port": 587,
  "email": "stark@gmail.com",
  "name": "Uspacy",
  "sender_name": "Sender Name",
  "access_level": "shared",
  "status": "connected",
  "created_at": 1711385960,
  "updated_at": 1729099182,
  "sync_folders": [
    [
      {
        "folder_name": "INBOX",
        "path": "INBOX",
        "delimitter": "/",
        "has_children": false,
        "is_root": true,
        "is_inbox": true
      },
      {
        "folder_name": "Notes",
        "path": "Notes",
        "delimitter": "/",
        "has_children": false,
        "is_root": true
      },
      {
        "folder_name": "Drafts",
        "path": "[Gmail]/Drafts",
        "delimitter": "/",
        "has_children": false,
        "is_root": false,
        "is_draft": true
      },
      {
        "folder_name": "Sent Mail",
        "path": "[Gmail]/Sent Mail",
        "delimitter": "/",
        "has_children": false,
        "is_root": false,
        "is_sent": true
      },
      {
        "folder_name": "Spam",
        "path": "[Gmail]/Spam",
        "delimitter": "/",
        "has_children": false,
        "is_root": false,
        "is_junk": true
      },
      {
        "folder_name": "Trash",
        "path": "[Gmail]/Trash",
        "delimitter": "/",
        "has_children": false,
        "is_root": false,
        "is_trash": true
      }
    ]
  ],
  "folders": [
    [
      {
        "id": 61,
        "email_id": 10,
        "parent_id": null,
        "folder_name": "INBOX",
        "path": "INBOX",
        "delimitter": "/",
        "is_trash": false,
        "is_spam": false,
        "is_draft": false,
        "is_junk": false,
        "is_sent": false,
        "is_inbox": true,
        "is_pending": false,
        "has_children": false,
        "is_root": true,
        "is_deleted": false,
        "message_count": 4998,
        "unread_message_count": 43
      },
      {
        "id": 64,
        "email_id": 10,
        "parent_id": null,
        "folder_name": "Sent Mail",
        "path": "[Gmail]/Sent Mail",
        "delimitter": "/",
        "is_trash": false,
        "is_spam": false,
        "is_draft": false,
        "is_junk": false,
        "is_sent": true,
        "is_inbox": false,
        "is_pending": false,
        "has_children": false,
        "is_root": false,
        "is_deleted": false,
        "message_count": 248,
        "unread_message_count": 0
      },
      {
        "id": 63,
        "email_id": 10,
        "parent_id": null,
        "folder_name": "Drafts",
        "path": "[Gmail]/Drafts",
        "delimitter": "/",
        "is_trash": false,
        "is_spam": false,
        "is_draft": true,
        "is_junk": false,
        "is_sent": false,
        "is_inbox": false,
        "is_pending": false,
        "has_children": false,
        "is_root": false,
        "is_deleted": false,
        "message_count": 73,
        "unread_message_count": 0
      },
      {
        "id": 66,
        "email_id": 10,
        "parent_id": null,
        "folder_name": "Trash",
        "path": "[Gmail]/Trash",
        "delimitter": "/",
        "is_trash": true,
        "is_spam": false,
        "is_draft": false,
        "is_junk": false,
        "is_sent": false,
        "is_inbox": false,
        "is_pending": false,
        "has_children": false,
        "is_root": false,
        "is_deleted": false,
        "message_count": 7612,
        "unread_message_count": 0
      }
    ]
  ],
  "access_roles": [
    {
      "user_id": 5,
      "name": "viewer"
    }
  ]
}