Notifications

The caller's own notification feed — mentions, assignments, invites, status changes.

GET/notifications

List notifications

The caller's own notifications, newest first.

Query parameters

limit	number	Page size.
isRead	boolean	Filter to read or unread.
type	string	mention \| assignment \| invite \| comment \| status_change \| deadline \| system.

bash

curl -X GET 'https://api.conexus-x.example/api/notifications' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "notifications": [
    {
      "_id": "66f1a2b3c4d5e6f7a8b9c9c1",
      "user": "66f1a2b3c4d5e6f7a8b9c0e1",
      "workspace": "66f1a2b3c4d5e6f7a8b9c0d1",
      "module": "66f1a2b3c4d5e6f7a8b9c1a1",
      "record": "66f1a2b3c4d5e6f7a8b9c4d1",
      "type": "mention",
      "title": "Dana mentioned you",
      "message": "@you can you take a look at the Northwind renewal?",
      "isRead": false,
      "readAt": null,
      "createdAt": "2026-08-02T15:41:00.000Z",
      "updatedAt": "2026-08-02T15:41:00.000Z"
    }
  ]
}

GET/notifications/unread-count

Get the unread count

A single number, for a badge.

bash

curl -X GET 'https://api.conexus-x.example/api/notifications/unread-count' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "count": 3
}

PATCH/notifications/{id}/read

Mark one read

Marks a single notification read.

Path parameters

id*

string

Notification id.

bash

curl -X PATCH 'https://api.conexus-x.example/api/notifications/{id}/read' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "notification": {
    "_id": "66f1a2b3c4d5e6f7a8b9c9c1",
    "user": "66f1a2b3c4d5e6f7a8b9c0e1",
    "workspace": "66f1a2b3c4d5e6f7a8b9c0d1",
    "module": "66f1a2b3c4d5e6f7a8b9c1a1",
    "record": "66f1a2b3c4d5e6f7a8b9c4d1",
    "type": "mention",
    "title": "Dana mentioned you",
    "message": "@you can you take a look at the Northwind renewal?",
    "isRead": true,
    "readAt": "2026-08-02T15:45:00.000Z",
    "createdAt": "2026-08-02T15:41:00.000Z",
    "updatedAt": "2026-08-02T15:41:00.000Z"
  }
}

POST/notifications/read-all

Mark all read

Marks every one of the caller's notifications read.

bash

curl -X POST 'https://api.conexus-x.example/api/notifications/read-all' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "message": "All notifications marked read."
}

DELETE/notifications/{id}

Delete a notification

Removes a single notification.

Path parameters

id*

string

Notification id.

bash

curl -X DELETE 'https://api.conexus-x.example/api/notifications/{id}' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "message": "Notification deleted."
}