Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• client_uuid string Required

Query parameters

• search string

  Search for a message by subject, content or participant (name / email).

• filter[incoming] boolean

  Filter by incoming or outgoing messages.

• filter[uuid] string

  Filter by a comma separated list of message UUIDs.

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [firm, mailbox, participants, attachments].

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, message_created_at]. Negative sign to denote DESC. Defaults to '-message_created_at'.

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • data array[object]
    Hide data attributes Show data 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.