Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[read] boolean

  Filter notifications by if they have been marked as read or not. leave blank to get both read and unread notifications

• per_page integer

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

Responses

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

  • uuid string

    Notification UUID

  • created_at string

    Timestamp of when the notification was created

  • updated_at string

    Timestamp of when the notification was updated

  • read_at string

    Timestamp of when the notification was read

  • data object
    Hide data attributes Show data attributes object

    • title string
    • description string
    • model_uuid string
    • model_type string
  • type string

    type of notification sent

  • notifiable object

    the notifiable model to notification is attached to, in most cases an Account

    Hide notifiable attributes Show notifiable 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
    • 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
  • triggered_by object

    the account that triggered this notification

    Hide triggered_by attributes Show triggered_by 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
    • 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