Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• uuid string 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.

  • name string

    Conversation title

  • slug string

    Conversation title as a slug

  • belongs_to_case boolean

    Whether or not the conversation belongs to a case.

  • case object

    Case the conversation belongs to (if included)

    Hide case attributes Show case attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • status string
    • type string
    • review_at string
    • assigned_to_uuids array[string]
    • group_uuids array[string]
    • completed_at string
    • value object
      Hide value attributes Show value attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • status_position integer
    • participants_count integer
    • participants string
    • task_board_uuid string
    • plans string
    • custom_fields string
  • participants_count integer

    Number of participants in conversation (if included)

  • participants array[object]

    Participants in this conversation (if included)

    Hide participants attributes Show participants attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • role string
    • first_name string
    • last_name string
    • name string
    • email string
    • photo_url string
    • firm string
    • primary_phone_number string
    • primary_email string
    • current_time_entry string
    • assigned_adviser string
    • assigned_administrator string
    • assigned_paraplanner string
    • introduced_by string
    • business_unit string
    • groups string
    • tags string
    • owners string
    • first_contact_date string
    • next_review_date string
    • previous_review_date string
    • anniversary_review_date string
    • with_login boolean
    • has_joint_account boolean
    • can_be_deleted string
    • joint_account_circle string
    • circles string
    • ownership_percentage integer
    • inactive_at string
    • last_interaction_at string
    • referral_code string
    • permissions object
      Hide permissions attributes Show permissions attributes object

      • firm:read array[string]
      • network:read array[string]
    • custom_fields string
    • external_references string
  • latest_message object

    The latest message of the conversation (if included)

    Hide latest_message attributes Show latest_message attributes object

    • uuid string
    • created_at string
    • updated_at string
    • deleted_at string
    • contents string
    • edited boolean
    • files string
    • author string
    • user string
    • reactions string
  • messages_count integer

    Number of messages in the conversation (if included)

  • files_count integer

    Number of files in the conversation (if included)

  • tags array[object]

    Conversation tags (if included)

    Hide tags attributes Show tags attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • colour string
  • pinned boolean

    Whether the conversation has been pinned to the top (if participants included)

  • is_admin boolean

    If the authenticated account is an admin of the conversation (if participants included)