Path parameters

• notableType string Required
• notableUuid string Required
• notable_type string Required

  Optional parameter. The type of model to look for. Make sure it is a valid model type that can have notes. Valid types are: ['account', 'board_task', 'case', 'conversation', 'illustration'] .

• notable_uuid string Required

  Optional parameter. The UUID of the notable model.

Query parameters

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [tags, mentionedAccounts,notable].

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[type] string

  Note type to filter by. Valid types are [call, note, meeting, email]

• filter[date_from] string

  Note created_at date to filter from a specific date, can be used with date_to for a range.

• filter[date_to] string

  Note created_at date to filter to from a specific date, can be used with date_from for a range.

• filter[contents] string

  Filter notes by a string to see if it's contents contains that string.

• filter[path] string

  Filter notes by a string to see if the path contains that string.

• filter[path_exact] string

  Filter notes by a string to see if the path is that string.

• per_page integer

  Number of results to return with pagination (Default 15. Max 500).

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, type]. Negative sign to denote DESC. Defaults to '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
    • created_at string
    • updated_at string
    • contents string
    • edited boolean
    • author_name string
    • account object
      Hide account attributes Show account attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email 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
      • 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
      • ownership_percentage integer
      • inactive_at string
      • custom_fields string
      • external_references string
    • mentioned_accounts array[object]
      Hide mentioned_accounts attributes Show mentioned_accounts attributes object

      • item string
      • contents string
    • tags array[object]
      Hide tags attributes Show tags attributes object

      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • colour string
    • type string
    • notable_type string
    • notable object
      Hide notable attributes Show notable attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email 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
      • 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
      • ownership_percentage integer
      • inactive_at string
      • custom_fields string
      • external_references string
    • external_references array[object]
      Hide external_references attributes Show external_references attributes object

      • uuid string
      • created_at string
      • updated_at string
      • third_party string
      • reference string