GET /api/v1/notifications
Personal access token & O auth2

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
      • 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
      • custom_fields string
      • external_references string
GET /api/v1/notifications 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/notifications' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "uuid": "3ea504d8-d45c-4f4c-bf7b-0990e82ada97",
  "created_at": "2026-02-06T09:09:43+00:00",
  "updated_at": "2026-02-06T09:09:43+00:00",
  "read_at": "2026-02-06T09:09:43+00:00",
  "data": {
    "data": {
      "title": "notification-title",
      "model_type": "firm",
      "model_uuid": "afbe2c92-6ab8-4558-88f1-fbfd7d6b624a",
      "description": "notification-description"
    },
    "type": "App/Notifications/AppNotification",
    "uuid": "e3f90b45-4fc6-4fb5-8b2d-cad5c81daad2",
    "read_at": "2026-02-06T09:09:43+00:00",
    "created_at": "2026-02-06T09:09:43+00:00",
    "notifiable": {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "b919b896-8186-416b-beb4-341e9ba4c91e",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "created_at": "2026-02-06T09:09:43+00:00",
      "first_name": "Gareth",
      "updated_at": "2026-02-06T09:09:43+00:00",
      "with_login": true,
      "inactive_at": "2026-02-06",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "referral_code": "ABC12345",
      "can_be_deleted": "false",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "next_review_date": "2026-02-06T09:09:43+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2026-02-06T09:09:43+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "last_interaction_at": "2026-02-06 09:09:43",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "previous_review_date": "2026-02-06T09:09:43+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2026-02-06T09:09:43+00:00"
    },
    "updated_at": "2026-02-06T09:09:43+00:00",
    "triggered_by": {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "c7ee936c-9dc0-4173-ac73-fc39c5fb25d1",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "created_at": "2026-02-06T09:09:43+00:00",
      "first_name": "Gareth",
      "updated_at": "2026-02-06T09:09:43+00:00",
      "with_login": true,
      "inactive_at": "2026-02-06",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "referral_code": "ABC12345",
      "can_be_deleted": "false",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "next_review_date": "2026-02-06T09:09:43+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2026-02-06T09:09:43+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "last_interaction_at": "2026-02-06 09:09:43",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "previous_review_date": "2026-02-06T09:09:43+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2026-02-06T09:09:43+00:00"
    }
  },
  "type": "App/Notifications/AppNotification",
  "notifiable": {
    "uuid": "605d842a-80c3-4818-b1df-1d792724336b",
    "created_at": "2026-02-06T09:09:43+00:00",
    "updated_at": "2026-02-06T09:09:43+00:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "firm": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-02-06T09:09:43+00:00",
    "next_review_date": "2026-02-06T09:09:43+00:00",
    "previous_review_date": "2026-02-06T09:09:43+00:00",
    "anniversary_review_date": "2026-02-06T09:09:43+00:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-02-06",
    "last_interaction_at": "2026-02-06 09:09:43",
    "referral_code": "ABC12345",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "triggered_by": {
    "uuid": "9b9a1eae-49b4-4b19-8a12-6fb338e22d1c",
    "created_at": "2026-02-06T09:09:43+00:00",
    "updated_at": "2026-02-06T09:09:43+00:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "firm": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-02-06T09:09:43+00:00",
    "next_review_date": "2026-02-06T09:09:43+00:00",
    "previous_review_date": "2026-02-06T09:09:43+00:00",
    "anniversary_review_date": "2026-02-06T09:09:43+00:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-02-06",
    "last_interaction_at": "2026-02-06 09:09:43",
    "referral_code": "ABC12345",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  }
}