Display the specified email.

GET /api/v1/mailboxes/message/{uuid}

Headers

Path parameters

uuid integer Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- message_created_at string
  
  The timestamp of when the message was sent.
- mailbox object
  
  The mailbox the message belongs to.
- firm object
  
  The firm the message belongs to.
- ancestors array[object]
  
  The thread of messages that come before this message
- descendants array[object]
  
  The thread of messages that come after this message.
- thread_count object
  
  The number of thread messages.
- participants array[object]
  
  The participants of the message.
- attachments array[object]
  
  The attachments of the message.
- subject string
  
  The subject of the message.
- incoming boolean
  
  Whether the message is incoming or outgoing.
- text string
  
  The plain text content of the message.
- html string
  
  The HTML content of the message. Only available when the message is retrieved directly.

GET /api/v1/mailboxes/message/{uuid}

curl \
 -X GET https://api.plannrcrm.com/api/v1/mailboxes/message/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "5c068021-f3ba-4946-8a80-ff25354a6552",
    "county": "Hampshire",
    "billing": {
      "invoice_email": "gareth@codepotato.co.uk",
      "invoice_county": "Hampshire",
      "invoice_country": "United Kingdom",
      "invoice_postcode": "PO7 7YH",
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville"
    },
    "country": "United Kingdom",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "month_end": 25,
    "town_city": "Waterlooville",
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "brand_colours": {
      "sidebar_text": "#ffffff",
      "sidebar_hover": "#0A0A42",
      "email_sub_text": "#ffffff",
      "sidebar_accent": "#36367E",
      "sidebar_active": "#53DBB8",
      "email_background": "#0E0E56",
      "email_button_text": "#ffffff",
      "sidebar_background": "#0E0E56",
      "sidebar_title_primary": "#FFC634",
      "email_button_background": "#36367E",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "email_logo_background_panel": "#36367E",
      "sidebar_title_secondary_hover": "#ffffff"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!"
  },
  "html": "<p>Message body here in HTML</p>",
  "text": "Message body here in plain text",
  "uuid": "d0aeeb64-cc64-4127-9a32-d23e3a2cf21e",
  "mailbox": {
    "name": "Test Mailbox",
    "type": "imap",
    "uuid": "be739722-14da-4c2f-99a6-6ac3bf9f47e8",
    "email": "test@example.org",
    "state": "connected",
    "enabled": true,
    "created_at": "2024-10-16T11:10:13+01:00",
    "created_by": {
      "firm": {
        "example": "App\\Http\\Resources\\FirmResource",
        "collection": false,
        "description": "Firm"
      },
      "name": {
        "example": "Gareth Thompson",
        "collection": false,
        "description": "Name"
      },
      "role": {
        "example": "client",
        "collection": false,
        "description": "Account role"
      },
      "tags": {
        "example": "App\\Http\\Resources\\TagResource",
        "collection": true,
        "description": "Tags"
      },
      "type": {
        "example": "client",
        "collection": false,
        "description": "Account type"
      },
      "uuid": {
        "example": "a8598894-6e3f-44bc-9892-366b803cef5e",
        "collection": false,
        "description": "The UUID of the resource."
      },
      "email": {
        "example": "gareth@codepotato.co.uk",
        "collection": false,
        "description": "Email"
      },
      "groups": {
        "example": "App\\Http\\Resources\\GroupResource",
        "collection": true,
        "description": "Groups"
      },
      "owners": {
        "example": "App\\Http\\Resources\\AccountResource",
        "collection": true,
        "description": "Accounts that own this account"
      },
      "last_name": {
        "example": "Thompson",
        "collection": false,
        "description": "Last name"
      },
      "created_at": {
        "example": "2024-10-16T11:10:13+01:00",
        "collection": false,
        "description": "The timestamp of when the resource was created."
      },
      "first_name": {
        "example": "Gareth",
        "collection": false,
        "description": "First name"
      },
      "updated_at": {
        "example": "2024-10-16T11:10:13+01:00",
        "collection": false,
        "description": "The timestamp of when the resource was updated."
      },
      "with_login": {
        "example": true,
        "collection": false,
        "description": "Denotes whether the account has a login to Plannr"
      },
      "custom_fields": {
        "example": "App\\Http\\Resources\\CustomFieldValueResource",
        "collection": true,
        "description": "Any custom fields on the model."
      },
      "introduced_by": {
        "example": "App\\Http\\Resources\\AccountResource",
        "collection": false,
        "description": "Introduced by"
      },
      "primary_email": {
        "example": "App\\Http\\Resources\\ContactDetailResource",
        "collection": false,
        "description": "Primary email"
      },
      "can_be_deleted": {
        "example": "false",
        "collection": false,
        "description": "Denotes if the account can be deleted"
      },
      "assigned_adviser": {
        "example": "App\\Http\\Resources\\AccountResource",
        "collection": false,
        "description": "Assigned adviser"
      },
      "next_review_date": {
        "example": "2024-10-16T11:10:13+01:00",
        "collection": false,
        "description": "Next review date"
      },
      "has_joint_account": {
        "example": true,
        "collection": false,
        "description": "Denotes whether this account belongs to a joint account too"
      },
      "current_time_entry": {
        "example": "App\\Http\\Resources\\TimeEntryResource",
        "collection": false,
        "description": "Current time entry"
      },
      "first_contact_date": {
        "example": "2024-10-16T11:10:13+01:00",
        "collection": false,
        "description": "First contact date"
      },
      "external_references": {
        "example": "App\\Http\\Resources\\ExternalReferenceResource",
        "collection": true,
        "description": "The external references that have been added to the client."
      },
      "assigned_paraplanner": {
        "example": "App\\Http\\Resources\\AccountResource",
        "collection": false,
        "description": "Assigned paraplanner"
      },
      "previous_review_date": {
        "example": "2024-10-16T11:10:13+01:00",
        "collection": false,
        "description": "Previous review date"
      },
      "primary_phone_number": {
        "example": "App\\Http\\Resources\\ContactDetailResource",
        "collection": false,
        "description": "Primary phone number"
      },
      "assigned_administrator": {
        "example": "App\\Http\\Resources\\AccountResource",
        "collection": false,
        "description": "Assigned administrator"
      },
      "anniversary_review_date": {
        "example": "2024-10-16T11:10:13+01:00",
        "collection": false,
        "description": "Anniversary review date"
      }
    },
    "updated_at": "2024-10-16T11:10:13+01:00",
    "message_count": 1
  },
  "subject": "Hello World",
  "incoming": true,
  "ancestors": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "html": "<p>Message body here in HTML</p>",
      "text": "Message body here in plain text",
      "uuid": "3f18187b-1d25-4fa3-a798-d68b310df5c6",
      "mailbox": "App\\Http\\Resources\\MailboxResource",
      "subject": "Hello World",
      "incoming": true,
      "ancestors": "App\\Http\\Resources\\MailboxMessageResource",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "attachments": "App\\Http\\Resources\\MailboxMessageAttachmentResource",
      "descendants": "App\\Http\\Resources\\MailboxMessageResource",
      "participants": "App\\Http\\Resources\\MailboxMessageParticipantResource",
      "thread_count": "App\\Http\\Resources\\MailboxMessageResource",
      "message_created_at": "2024-10-16T11:10:13+01:00"
    }
  ],
  "created_at": "2024-10-16T11:10:13+01:00",
  "updated_at": "2024-10-16T11:10:13+01:00",
  "attachments": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "example.pdf",
      "size": 123456,
      "type": "application/pdf",
      "uuid": "bd78e0fc-f610-4868-a929-8e9ced924fb4",
      "status": "uploaded",
      "extension": "pdf",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "download_url": "https://example.com/download/attachment"
    }
  ],
  "descendants": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "html": "<p>Message body here in HTML</p>",
      "text": "Message body here in plain text",
      "uuid": "b9b496e0-50e2-4b5d-bc81-81ad79f5661c",
      "mailbox": "App\\Http\\Resources\\MailboxResource",
      "subject": "Hello World",
      "incoming": true,
      "ancestors": "App\\Http\\Resources\\MailboxMessageResource",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "attachments": "App\\Http\\Resources\\MailboxMessageAttachmentResource",
      "descendants": "App\\Http\\Resources\\MailboxMessageResource",
      "participants": "App\\Http\\Resources\\MailboxMessageParticipantResource",
      "thread_count": "App\\Http\\Resources\\MailboxMessageResource",
      "message_created_at": "2024-10-16T11:10:13+01:00"
    }
  ],
  "participants": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "John Doe",
      "type": "cc",
      "uuid": "735cdff8-98ce-4478-b82d-8fed91c18d24",
      "email": "john.doe@example.com",
      "mailbox": "App\\Http\\Resources\\MailboxResource",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "mailbox_message": "App\\Http\\Resources\\MailboxMessageResource"
    }
  ],
  "thread_count": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "html": "<p>Message body here in HTML</p>",
    "text": "Message body here in plain text",
    "uuid": "cae9dc28-7482-4101-b441-6a448b8828ac",
    "mailbox": "App\\Http\\Resources\\MailboxResource",
    "subject": "Hello World",
    "incoming": true,
    "ancestors": "App\\Http\\Resources\\MailboxMessageResource",
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "attachments": "App\\Http\\Resources\\MailboxMessageAttachmentResource",
    "descendants": "App\\Http\\Resources\\MailboxMessageResource",
    "participants": "App\\Http\\Resources\\MailboxMessageParticipantResource",
    "thread_count": "App\\Http\\Resources\\MailboxMessageResource",
    "message_created_at": "2024-10-16T11:10:13+01:00"
  },
  "message_created_at": "2024-10-16T11:10:13+01:00"
}