Get a notification

GET /api/v1/notifications/{id}
Personal access token & O auth2

Path parameters

  • id string Required

    The ID of the notification.

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

      array of data that was sent on the notification

      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
      • 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
      • custom_fields string
      • external_references string
GET /api/v1/notifications/{id} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/notifications/architecto' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "title": "notification-title",
    "model_type": "firm",
    "model_uuid": "edc42cde-223f-4019-b5f1-4ff48c641f9e",
    "description": "notification-description"
  },
  "type": "App/Notifications/AppNotification",
  "uuid": "9eb9df92-85ef-413a-8974-cfeb16110138",
  "read_at": "2025-07-28T14:57:25+01:00",
  "created_at": "2025-07-28T14:57:25+01:00",
  "notifiable": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "561683d0-d28e-4e1d-927c-2ad361b654c5",
    "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": "2025-07-28T14:57:25+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-07-28T14:57:25+01:00",
    "with_login": true,
    "inactive_at": "2025-07-28",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-07-28T14:57:25+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-07-28T14:57:25+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-07-28T14:57:25+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-07-28T14:57:25+01:00"
  },
  "updated_at": "2025-07-28T14:57:25+01:00",
  "triggered_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "21a25500-8533-4361-bbd3-d25622f89233",
    "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": "2025-07-28T14:57:25+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-07-28T14:57:25+01:00",
    "with_login": true,
    "inactive_at": "2025-07-28",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-07-28T14:57:25+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-07-28T14:57:25+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-07-28T14:57:25+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-07-28T14:57:25+01:00"
  }
}