Get all notifications

GET /api/v1/notifications
Personal access token & OAuth2

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

      array of data that was sent on the notification

      Additional properties are allowed.

    • type string

      type of notification sent

    • notifiable object

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

      Additional properties are allowed.

    • triggered_by object

      the account that triggered this notification

      Additional properties are allowed.
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": "f47a179e-1beb-4933-8f62-ce11cb7242b2",
    "description": "notification-description"
  },
  "type": "App/Notifications/AppNotification",
  "uuid": "d5759321-6ba4-4039-99bf-539149a60dbb",
  "read_at": "2025-02-20T10:13:00+00:00",
  "created_at": "2025-02-20T10:13:00+00:00",
  "notifiable": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "a06cbdbc-666e-4b4b-ba6f-32b82401aa93",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-02-20T10:13:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-02-20T10:13:00+00:00",
    "with_login": true,
    "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-02-20T10:13:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-02-20T10:13:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-02-20T10:13:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-02-20T10:13:00+00:00"
  },
  "updated_at": "2025-02-20T10:13:00+00:00",
  "triggered_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "8a85a843-dbcb-453c-9af1-21d9cdf0f88a",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-02-20T10:13:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-02-20T10:13:00+00:00",
    "with_login": true,
    "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-02-20T10:13:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-02-20T10:13:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-02-20T10:13:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-02-20T10:13:00+00:00"
  }
}