Headers
-
Content-Type
string -
Accept
string
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).
GET
/api/v1/notifications
curl \
--request GET 'https://api.plannrcrm.com/api/v1/notifications' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"data": {
"title": "notification-title",
"model_type": "firm",
"model_uuid": "f7b8f742-faf8-4814-920b-5a7a5cc60dd0",
"description": "notification-description"
},
"type": "App/Notifications/AppNotification",
"uuid": "de7b2274-05ff-4200-af1d-b2774ec9116f",
"read_at": "2025-04-22T13:44:16+01:00",
"created_at": "2025-04-22T13:44:16+01:00",
"notifiable": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "d57edb97-79cc-44ed-9284-ef37ba597e22",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:16+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:16+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"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-04-22T13:44:16+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-22T13:44:16+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-04-22T13:44:16+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-22T13:44:16+01:00"
},
"updated_at": "2025-04-22T13:44:16+01:00",
"triggered_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "d4c2707a-188d-4e02-8527-c220691cafd9",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:16+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:16+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"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-04-22T13:44:16+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-22T13:44:16+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-04-22T13:44:16+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-22T13:44:16+01:00"
}
}