v1

latestOpenAPI 3.1.02026-07-14159142161.9 KB
emailService

Retrieve Letters by Folder

Retrieves a list of letters from the specified folder. Supports pagination.

get/email/v1/letters/by_folder/{folderId}

Path parameters

folderIdinteger required
Example:61

The ID of the email folder

Query parameters

pageinteger

current page

listnumber

how many items should be per page

Response

OK

Example response

{
  "data": [
    {
      "destination_folder_id": null,
      "subject": "Pitch deck",
      "body": "Pitch deck description",
      "body_html": "<div dir=\"ltr\">Pitch deck description</div>\r\n",
      "parent_message_id": "imap_parent_message_id",
      "main_message_id": "imap_main_message_id",
      "is_read": true,
      "contacts": [
        {
          "id": 1,
          "email": "to@gmail.com",
          "name": "To",
          "pivot": [
            {
              "contact_type": "to"
            }
          ]
        },
        {
          "id": 2,
          "email": "from@gmail.com",
          "name": "From",
          "pivot": [
            {
              "contact_type": "from"
            }
          ]
        },
        {
          "id": 3,
          "email": "cc@gmail.com",
          "name": "CC",
          "pivot": [
            {
              "contact_type": "cc"
            }
          ]
        }
      ]
    }
  ]
}