Display the specified email.

GET /api/v1/mailboxes/message/{uuid}
Personal access token & O auth2

Path parameters

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 \
 --request GET 'https://api.plannrcrm.com/api/v1/mailboxes/message/uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "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": "3523c1c3-3f31-4622-851c-3dce0e8ba1bd",
    "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": "2025-06-04T16:49:34+01:00",
    "updated_at": "2025-06-04T16:49:34+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!",
    "show_fact_find_illustrations": true
  },
  "html": "<p>Message body here in HTML</p>",
  "text": "Message body here in plain text",
  "uuid": "74bcdce7-5993-44f4-860d-f703e9c727d9",
  "mailbox": {
    "name": "Test Mailbox",
    "type": "imap",
    "uuid": "568d6315-89f3-4213-8d7b-414b4e38a9c4",
    "email": "test@example.org",
    "state": "connected",
    "enabled": true,
    "created_at": "2025-06-04T16:49:34+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": "b7b7cb22-3ec0-4f9e-8664-257d3e37174d",
        "collection": false,
        "description": "The UUID of the resource."
      },
      "email": {
        "example": "gareth@codepotato.co.uk",
        "collection": false,
        "description": "(Deprecated - Please use primary_email instead). The email of the account."
      },
      "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": "2025-06-04T16:49:34+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": "2025-06-04T16:49:34+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"
      },
      "inactive_at": {
        "example": "2025-06-04",
        "collection": false,
        "description": "Inactive from date"
      },
      "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": "2025-06-04T16:49:34+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": "2025-06-04T16:49:34+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"
      },
      "joint_account_circle": {
        "example": "App\\Http\\Resources\\CircleResource",
        "collection": false,
        "description": "This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles."
      },
      "ownership_percentage": {
        "example": 100,
        "collection": false,
        "description": "Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)"
      },
      "previous_review_date": {
        "example": "2025-06-04T16:49:34+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": "2025-06-04T16:49:34+01:00",
        "collection": false,
        "description": "Anniversary review date"
      }
    },
    "updated_at": "2025-06-04T16:49:34+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": "edc6deca-a785-4df8-a3a4-924e5d6724f6",
      "mailbox": "App\\Http\\Resources\\MailboxResource",
      "subject": "Hello World",
      "incoming": true,
      "ancestors": "App\\Http\\Resources\\MailboxMessageResource",
      "created_at": "2025-06-04T16:49:34+01:00",
      "updated_at": "2025-06-04T16:49:34+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": "2025-06-04T16:49:34+01:00"
    }
  ],
  "created_at": "2025-06-04T16:49:34+01:00",
  "updated_at": "2025-06-04T16:49:34+01:00",
  "attachments": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "example.pdf",
      "size": 123456,
      "type": "application/pdf",
      "uuid": "c6c96e65-d5ad-423d-a8a9-2f6f3ff724ea",
      "status": "uploaded",
      "extension": "pdf",
      "created_at": "2025-06-04T16:49:34+01:00",
      "updated_at": "2025-06-04T16:49:34+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": "819bde9c-d50f-47ad-913e-dbc440f9643f",
      "mailbox": "App\\Http\\Resources\\MailboxResource",
      "subject": "Hello World",
      "incoming": true,
      "ancestors": "App\\Http\\Resources\\MailboxMessageResource",
      "created_at": "2025-06-04T16:49:34+01:00",
      "updated_at": "2025-06-04T16:49:34+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": "2025-06-04T16:49:34+01:00"
    }
  ],
  "participants": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "John Doe",
      "type": "cc",
      "uuid": "39fe1fd6-d2f9-49f5-a694-e5b7dea806fc",
      "email": "john.doe@example.com",
      "mailbox": "App\\Http\\Resources\\MailboxResource",
      "created_at": "2025-06-04T16:49:34+01:00",
      "updated_at": "2025-06-04T16:49:34+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": "dbde5647-0475-4665-880e-a0f25356a955",
    "mailbox": "App\\Http\\Resources\\MailboxResource",
    "subject": "Hello World",
    "incoming": true,
    "ancestors": "App\\Http\\Resources\\MailboxMessageResource",
    "created_at": "2025-06-04T16:49:34+01:00",
    "updated_at": "2025-06-04T16:49:34+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": "2025-06-04T16:49:34+01:00"
  },
  "message_created_at": "2025-06-04T16:49:34+01:00"
}