Display the specified email. | PlannrCRM API documentation

Display the specified email. Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

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

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required

Query parameters

per_page integer

Number of ancestor/descendant messages to return per page (Default 25. Max 500).
page[ancestors] integer

Page number for ancestor messages.
page[descendants] integer

Page number for descendant messages.

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.
  
  Hide mailbox attributes Show mailbox attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  created_by object
  
  Hide created_by attributes Show created_by attributes object
  
  uuid object
  
  Hide uuid attributes Show uuid attributes object
  
  example string
  
  description string
  
  collection boolean
  
  created_at object
  
  Hide created_at attributes Show created_at attributes object
  
  example string
  
  description string
  
  collection boolean
  
  updated_at object
  
  Hide updated_at attributes Show updated_at attributes object
  
  example string
  
  description string
  
  collection boolean
  
  type object
  
  Hide type attributes Show type attributes object
  
  example string
  
  description string
  
  collection boolean
  
  role object
  
  Hide role attributes Show role attributes object
  
  example string
  
  description string
  
  collection boolean
  
  first_name object
  
  Hide first_name attributes Show first_name attributes object
  
  example string
  
  description string
  
  collection boolean
  
  last_name object
  
  Hide last_name attributes Show last_name attributes object
  
  example string
  
  description string
  
  collection boolean
  
  name object
  
  Hide name attributes Show name attributes object
  
  example string
  
  description string
  
  collection boolean
  
  email object
  
  Hide email attributes Show email attributes object
  
  example string
  
  description string
  
  collection boolean
  
  photo_url object
  
  Hide photo_url attributes Show photo_url attributes object
  
  example string
  
  description string
  
  collection boolean
  
  firm object
  
  Hide firm attributes Show firm attributes object
  
  example string
  
  description string
  
  collection boolean
  
  primary_phone_number object
  
  Hide primary_phone_number attributes Show primary_phone_number attributes object
  
  example string
  
  description string
  
  collection boolean
  
  primary_email object
  
  Hide primary_email attributes Show primary_email attributes object
  
  example string
  
  description string
  
  collection boolean
  
  current_time_entry object
  
  Hide current_time_entry attributes Show current_time_entry attributes object
  
  example string
  
  description string
  
  collection boolean
  
  assigned_adviser object
  
  Hide assigned_adviser attributes Show assigned_adviser attributes object
  
  example string
  
  description string
  
  collection boolean
  
  assigned_administrator object
  
  Hide assigned_administrator attributes Show assigned_administrator attributes object
  
  example string
  
  description string
  
  collection boolean
  
  assigned_paraplanner object
  
  Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object
  
  example string
  
  description string
  
  collection boolean
  
  introduced_by object
  
  Hide introduced_by attributes Show introduced_by attributes object
  
  example string
  
  description string
  
  collection boolean
  
  business_unit object
  
  Hide business_unit attributes Show business_unit attributes object
  
  example string
  
  description string
  
  collection boolean
  
  groups object
  
  Hide groups attributes Show groups attributes object
  
  example string
  
  description string
  
  collection boolean
  
  tags object
  
  Hide tags attributes Show tags attributes object
  
  example string
  
  description string
  
  collection boolean
  
  owners object
  
  Hide owners attributes Show owners attributes object
  
  example string
  
  description string
  
  collection boolean
  
  first_contact_date object
  
  Hide first_contact_date attributes Show first_contact_date attributes object
  
  example string
  
  description string
  
  collection boolean
  
  next_review_date object
  
  Hide next_review_date attributes Show next_review_date attributes object
  
  example string
  
  description string
  
  collection boolean
  
  previous_review_date object
  
  Hide previous_review_date attributes Show previous_review_date attributes object
  
  example string
  
  description string
  
  collection boolean
  
  anniversary_review_date object
  
  Hide anniversary_review_date attributes Show anniversary_review_date attributes object
  
  example string
  
  description string
  
  collection boolean
  
  terms_of_business_at object
  
  Hide terms_of_business_at attributes Show terms_of_business_at attributes object
  
  example string
  
  description string
  
  collection boolean
  
  client_agreement_at object
  
  Hide client_agreement_at attributes Show client_agreement_at attributes object
  
  example string
  
  description string
  
  collection boolean
  
  with_login object
  
  Hide with_login attributes Show with_login attributes object
  
  example boolean
  
  description string
  
  collection boolean
  
  has_joint_account object
  
  Hide has_joint_account attributes Show has_joint_account attributes object
  
  example boolean
  
  description string
  
  collection boolean
  
  can_be_deleted object
  
  Hide can_be_deleted attributes Show can_be_deleted attributes object
  
  example string
  
  description string
  
  collection boolean
  
  joint_account_circle object
  
  Hide joint_account_circle attributes Show joint_account_circle attributes object
  
  example string
  
  description string
  
  collection boolean
  
  circles object
  
  Hide circles attributes Show circles attributes object
  
  example string
  
  description string
  
  collection boolean
  
  ownership_percentage object
  
  Hide ownership_percentage attributes Show ownership_percentage attributes object
  
  example integer
  
  description string
  
  collection boolean
  
  inactive_at object
  
  Hide inactive_at attributes Show inactive_at attributes object
  
  example string
  
  description string
  
  collection boolean
  
  last_interaction_at object
  
  Hide last_interaction_at attributes Show last_interaction_at attributes object
  
  example string
  
  description string
  
  collection boolean
  
  referral_code object
  
  Hide referral_code attributes Show referral_code attributes object
  
  example string
  
  description string
  
  collection boolean
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  example object
  
  Hide example attributes Show example attributes object
  
  firm:read array[string]
  
  network:read array[string]
  
  description string
  
  collection boolean
  
  custom_fields object
  
  Hide custom_fields attributes Show custom_fields attributes object
  
  example string
  
  description string
  
  collection boolean
  
  external_references object
  
  Hide external_references attributes Show external_references attributes object
  
  example string
  
  description string
  
  collection boolean
  
  type string
  
  email string
  
  name string
  
  state string
  
  enabled boolean
  
  message_count integer
- firm object
  
  The firm the message belongs to.
  
  Hide firm attributes Show firm attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  address_1 string
  
  address_2 string
  
  town_city string
  
  county string
  
  postcode string
  
  country string
  
  regulatory_text string
  
  logo string
  
  logo_icon string
  
  brand_colours object
  
  Hide brand_colours attributes Show brand_colours attributes object
  
  sidebar_background string
  
  sidebar_accent string
  
  sidebar_text string
  
  sidebar_hover string
  
  sidebar_active string
  
  sidebar_title_background string
  
  sidebar_title_primary string
  
  sidebar_title_secondary string
  
  sidebar_title_secondary_hover string
  
  email_background string
  
  email_logo_background_panel string
  
  email_sub_text string
  
  email_button_background string
  
  email_button_text string
  
  portal_sidebar_button_background string
  
  portal_sidebar_button_hover string
  
  portal_sidebar_button_active string
  
  portal_brand_title string
  
  portal_brand_sub_title string
  
  portal_sidebar_title string
  
  portal_sidebar_text string
  
  portal_sidebar_text_hover string
  
  portal_sidebar_text_active string
  
  portal_sidebar_icon string
  
  portal_sidebar_icon_hover string
  
  portal_sidebar_icon_active string
  
  portal_background string
  
  portal_sidebar_account_title string
  
  portal_sidebar_account_email string
  
  portal_sidebar_divider string
  
  portal_dashboard_bg_one string
  
  portal_dashboard_bg_two string
  
  portal_sidebar_collapse_button string
  
  portal_sidebar_collapse_button_hover string
  
  portal_sidebar_user_select_background string
  
  portal_sidebar_user_select_hover string
  
  portal_sidebar_user_select_text string
  
  portal_sidebar_user_select_text_hover string
  
  portal_sidebar_user_select_border string
  
  portal_sidebar_user_select_border_hover string
  
  is_subscribed boolean
  
  addon_subscriptions string
  
  keep_deleted_files_for integer
  
  tax number
  
  month_end integer
  
  statement_frequency string
  
  billing object
  
  Hide billing attributes Show billing attributes object
  
  invoice_address_1 string
  
  invoice_address_2 string
  
  invoice_town_city string
  
  invoice_county string
  
  invoice_postcode string
  
  invoice_country string
  
  invoice_email string
  
  task_board_template string
  
  ip_whitelist array[string]
  
  welcome_paragraph_html string
  
  email_welcome_paragraph_html string
  
  show_fact_find_illustrations boolean
  
  cc_email_addresses array[string]
  
  bcc_email_addresses array[string]
  
  reply_to_email_address string
  
  mobile_app_support_number string
  
  mobile_app_support_email string
- ancestors object
  
  Paginated thread of messages that come before this message
  
  Hide ancestors attributes Show ancestors attributes object
  
  data string
  
  meta string
  
  links string
- descendants object
  
  Paginated thread of messages that come after this message
  
  Hide descendants attributes Show descendants attributes object
  
  data string
  
  meta string
  
  links string
- thread_count integer
  
  The number of thread messages.
- participants array[object]
  
  The participants of the message.
  
  Hide participants attributes Show participants attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  mailbox_message string
  
  firm string
  
  mailbox string
  
  type string
  
  name string
  
  email string
- attachments array[object]
  
  The attachments of the message.
  
  Hide attachments attributes Show attachments attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  firm string
  
  name string
  
  type string
  
  size integer
  
  download_url string
  
  extension string
  
  status string
- 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/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "uuid": "cfa5a710-2d2b-4a7b-9f4d-45f3dea260da",
  "created_at": "2026-06-27T09:33:41+01:00",
  "updated_at": "2026-06-27T09:33:41+01:00",
  "message_created_at": "2026-06-27T09:33:41+01:00",
  "mailbox": {
    "uuid": "af7e9165-f9d9-410c-a22f-0c84ec17c26c",
    "created_at": "2026-06-27T09:33:41+01:00",
    "updated_at": "2026-06-27T09:33:41+01:00",
    "created_by": {
      "uuid": {
        "example": "d0bf2756-6297-4394-92f0-e5c1d2231483",
        "description": "The UUID of the resource.",
        "collection": false
      },
      "created_at": {
        "example": "2026-06-27T09:33:41+01:00",
        "description": "The timestamp of when the resource was created.",
        "collection": false
      },
      "updated_at": {
        "example": "2026-06-27T09:33:41+01:00",
        "description": "The timestamp of when the resource was updated.",
        "collection": false
      },
      "type": {
        "example": "client",
        "description": "Account type",
        "collection": false
      },
      "role": {
        "example": "client",
        "description": "Account role",
        "collection": false
      },
      "first_name": {
        "example": "Gareth",
        "description": "First name",
        "collection": false
      },
      "last_name": {
        "example": "Thompson",
        "description": "Last name",
        "collection": false
      },
      "name": {
        "example": "Gareth Thompson",
        "description": "Name",
        "collection": false
      },
      "email": {
        "example": "gareth@codepotato.co.uk",
        "description": "(Deprecated - Please use primary_email instead). The email of the account.",
        "collection": false
      },
      "photo_url": {
        "example": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "description": "URL for initial avatar image",
        "collection": false
      },
      "firm": {
        "example": "App\\Http\\Resources\\FirmResource",
        "description": "Firm",
        "collection": false
      },
      "primary_phone_number": {
        "example": "App\\Http\\Resources\\ContactDetailResource",
        "description": "Primary phone number",
        "collection": false
      },
      "primary_email": {
        "example": "App\\Http\\Resources\\ContactDetailResource",
        "description": "Primary email",
        "collection": false
      },
      "current_time_entry": {
        "example": "App\\Http\\Resources\\TimeEntryResource",
        "description": "Current time entry",
        "collection": false
      },
      "assigned_adviser": {
        "example": "App\\Http\\Resources\\AccountResource",
        "description": "Assigned adviser",
        "collection": false
      },
      "assigned_administrator": {
        "example": "App\\Http\\Resources\\AccountResource",
        "description": "Assigned administrator",
        "collection": false
      },
      "assigned_paraplanner": {
        "example": "App\\Http\\Resources\\AccountResource",
        "description": "Assigned paraplanner",
        "collection": false
      },
      "introduced_by": {
        "example": "App\\Http\\Resources\\AccountResource",
        "description": "Introduced by",
        "collection": false
      },
      "business_unit": {
        "example": "App\\Http\\Resources\\BusinessUnitResource",
        "description": "The business unit this account belongs to",
        "collection": false
      },
      "groups": {
        "example": "App\\Http\\Resources\\GroupResource",
        "description": "Groups",
        "collection": true
      },
      "tags": {
        "example": "App\\Http\\Resources\\TagResource",
        "description": "Tags",
        "collection": true
      },
      "owners": {
        "example": "App\\Http\\Resources\\AccountResource",
        "description": "Accounts that own this account",
        "collection": true
      },
      "first_contact_date": {
        "example": "2026-06-27T09:33:41+01:00",
        "description": "First contact date",
        "collection": false
      },
      "next_review_date": {
        "example": "2026-06-27T09:33:41+01:00",
        "description": "Next review date",
        "collection": false
      },
      "previous_review_date": {
        "example": "2026-06-27T09:33:41+01:00",
        "description": "Previous review date",
        "collection": false
      },
      "anniversary_review_date": {
        "example": "2026-06-27T09:33:41+01:00",
        "description": "Anniversary review date",
        "collection": false
      },
      "terms_of_business_at": {
        "example": "2026-06-27T09:33:41+01:00",
        "description": "Date the Terms of Business were agreed and signed",
        "collection": false
      },
      "client_agreement_at": {
        "example": "2026-06-27T09:33:41+01:00",
        "description": "Date the client agreement was agreed and signed",
        "collection": false
      },
      "with_login": {
        "example": true,
        "description": "Denotes whether the account has a login to Plannr",
        "collection": false
      },
      "has_joint_account": {
        "example": true,
        "description": "Denotes whether this account belongs to a joint account too",
        "collection": false
      },
      "can_be_deleted": {
        "example": "false",
        "description": "Denotes if the account can be deleted",
        "collection": false
      },
      "joint_account_circle": {
        "example": "App\\Http\\Resources\\CircleResource",
        "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.",
        "collection": false
      },
      "circles": {
        "example": "App\\Http\\Resources\\CircleResource",
        "description": "The circles the account belongs to",
        "collection": true
      },
      "ownership_percentage": {
        "example": 100,
        "description": "Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)",
        "collection": false
      },
      "inactive_at": {
        "example": "2026-06-27",
        "description": "Inactive from date",
        "collection": false
      },
      "last_interaction_at": {
        "example": "2026-06-27 09:33:41",
        "description": "Last interaction date",
        "collection": false
      },
      "referral_code": {
        "example": "ABC12345",
        "description": "Unique referral code for the employee account (employees only)",
        "collection": false
      },
      "permissions": {
        "example": {
          "firm:read": [
            "firm"
          ],
          "network:read": [
            "network:uuid"
          ]
        },
        "description": "Permission map where keys are permission names and values are target arrays",
        "collection": false
      },
      "custom_fields": {
        "example": "App\\Http\\Resources\\CustomFieldValueResource",
        "description": "Any custom fields on the model.",
        "collection": true
      },
      "external_references": {
        "example": "App\\Http\\Resources\\ExternalReferenceResource",
        "description": "The external references that have been added to the client.",
        "collection": true
      }
    },
    "type": "imap",
    "email": "test@example.org",
    "name": "Test Mailbox",
    "state": "connected",
    "enabled": true,
    "message_count": 1
  },
  "firm": {
    "uuid": "ab5facc0-3c5f-4e48-baf6-fbe86d542ded",
    "created_at": "2026-06-27T09:33:41+01:00",
    "updated_at": "2026-06-27T09:33:41+01:00",
    "name": "Codepotato",
    "slug": "codepotato",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "town_city": "Waterlooville",
    "county": "Hampshire",
    "postcode": "PO7 7YH",
    "country": "United Kingdom",
    "regulatory_text": "Regulatory text",
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "brand_colours": {
      "sidebar_background": "#0E0E56",
      "sidebar_accent": "#36367E",
      "sidebar_text": "#FFFFFF",
      "sidebar_hover": "#0A0A42",
      "sidebar_active": "#53DBB8",
      "sidebar_title_background": "#36367E",
      "sidebar_title_primary": "#FFC634",
      "sidebar_title_secondary": "#FFFFFF",
      "sidebar_title_secondary_hover": "#FFFFFF",
      "email_background": "#0E0E56",
      "email_logo_background_panel": "#36367E",
      "email_sub_text": "#FFFFFF",
      "email_button_background": "#36367E",
      "email_button_text": "#FFFFFF",
      "portal_sidebar_button_background": "#F6F6F6",
      "portal_sidebar_button_hover": "#FFFFFF",
      "portal_sidebar_button_active": "#FFFFFF",
      "portal_brand_title": "#323B4B",
      "portal_brand_sub_title": "#828994",
      "portal_sidebar_title": "#11151D",
      "portal_sidebar_text": "#323B4B",
      "portal_sidebar_text_hover": "#323B4B",
      "portal_sidebar_text_active": "#323B4B",
      "portal_sidebar_icon": "#828994",
      "portal_sidebar_icon_hover": "#828994",
      "portal_sidebar_icon_active": "#828994",
      "portal_background": "#F6F6F6",
      "portal_sidebar_account_title": "#11151D",
      "portal_sidebar_account_email": "#828994",
      "portal_sidebar_divider": "#E3E5E9",
      "portal_dashboard_bg_one": "#EF4583",
      "portal_dashboard_bg_two": "#FFC634",
      "portal_sidebar_collapse_button": "#828994",
      "portal_sidebar_collapse_button_hover": "#B3B9C4",
      "portal_sidebar_user_select_background": "#F6F6F6",
      "portal_sidebar_user_select_hover": "#F6F6F6",
      "portal_sidebar_user_select_text": "#323B4B",
      "portal_sidebar_user_select_text_hover": "#323B4B",
      "portal_sidebar_user_select_border": "#EEEEEE",
      "portal_sidebar_user_select_border_hover": "#828994"
    },
    "is_subscribed": true,
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "keep_deleted_files_for": 30,
    "tax": 17.5,
    "month_end": 25,
    "statement_frequency": "monthly",
    "billing": {
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville",
      "invoice_county": "Hampshire",
      "invoice_postcode": "PO7 7YH",
      "invoice_country": "United Kingdom",
      "invoice_email": "gareth@codepotato.co.uk"
    },
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!",
    "show_fact_find_illustrations": true,
    "cc_email_addresses": [
      "jack@example.com",
      "jill@example.com"
    ],
    "bcc_email_addresses": [
      "jack@example.com",
      "jill@example.com"
    ],
    "reply_to_email_address": "jack@example.com",
    "mobile_app_support_number": "01234 567890",
    "mobile_app_support_email": "support@example.com"
  },
  "ancestors": {
    "data": "App\\Http\\Resources\\MailboxMessageResource",
    "meta": "object",
    "links": "object"
  },
  "descendants": {
    "data": "App\\Http\\Resources\\MailboxMessageResource",
    "meta": "object",
    "links": "object"
  },
  "thread_count": 0,
  "participants": [
    {
      "uuid": "261eb8b8-5d4e-43b4-a811-9a66a6054898",
      "created_at": "2026-06-27T09:33:41+01:00",
      "updated_at": "2026-06-27T09:33:41+01:00",
      "mailbox_message": "App\\Http\\Resources\\MailboxMessageResource",
      "firm": "App\\Http\\Resources\\FirmResource",
      "mailbox": "App\\Http\\Resources\\MailboxResource",
      "type": "cc",
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  ],
  "attachments": [
    {
      "uuid": "07e1750a-a902-47b1-9858-a011b3d6761e",
      "created_at": "2026-06-27T09:33:41+01:00",
      "updated_at": "2026-06-27T09:33:41+01:00",
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "example.pdf",
      "type": "application/pdf",
      "size": 123456,
      "download_url": "https://example.com/download/attachment",
      "extension": "pdf",
      "status": "uploaded"
    }
  ],
  "subject": "Hello World",
  "incoming": true,
  "text": "Message body here in plain text",
  "html": "<p>Message body here in HTML</p>"
}