Notifications

All Notifications

get

This endpoint is used to fetch all notifications in the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

notification_idstring · max: 25Required

user_idstringRequired

notification_typeintegerOptional

titlestringOptional

descriptionstringOptional

notify_timestring · date-timeOptional

readbooleanOptional

categorystringOptional

is_systembooleanOptional

get/api/notifyhub/notify-info/

GET /api/notifyhub/notify-info/?items_per_page=1&page=1 HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "notification_id": "text",
    "user_id": "text",
    "notification_type": 1,
    "title": "text",
    "description": "text",
    "notification_obj": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "notify_time": "2026-01-01T00:00:00.000Z",
    "read": true,
    "category": "text",
    "is_system": true
  }
]

post

API endpoint that allows Notifications to be created, viewed, deleted or edited.

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

notification_idstring · max: 25Required

user_idstringRequired

notification_typeintegerOptional

titlestringOptional

descriptionstringOptional

notify_timestring · date-timeOptional

readbooleanOptional

categorystringOptional

is_systembooleanOptional

Responses

201Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

notification_idstring · max: 25Required

user_idstringRequired

notification_typeintegerOptional

titlestringOptional

descriptionstringOptional

notify_timestring · date-timeOptional

readbooleanOptional

categorystringOptional

is_systembooleanOptional

post/api/notifyhub/notify-info/

POST /api/notifyhub/notify-info/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "notification_id": "text",
  "user_id": "text",
  "notification_type": 1,
  "title": "text",
  "description": "text",
  "notification_obj": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notify_time": "2026-01-01T00:00:00.000Z",
  "read": true,
  "category": "text",
  "is_system": true
}

201Success

{
  "notification_id": "text",
  "user_id": "text",
  "notification_type": 1,
  "title": "text",
  "description": "text",
  "notification_obj": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notify_time": "2026-01-01T00:00:00.000Z",
  "read": true,
  "category": "text",
  "is_system": true
}

get

API endpoint that allows Notifications to be created, viewed, deleted or edited.

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

idstringRequired

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

notification_idstring · max: 25Required

user_idstringRequired

notification_typeintegerOptional

titlestringOptional

descriptionstringOptional

notify_timestring · date-timeOptional

readbooleanOptional

categorystringOptional

is_systembooleanOptional

get/api/notifyhub/notify-info/{id}/

GET /api/notifyhub/notify-info/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "notification_id": "text",
  "user_id": "text",
  "notification_type": 1,
  "title": "text",
  "description": "text",
  "notification_obj": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notify_time": "2026-01-01T00:00:00.000Z",
  "read": true,
  "category": "text",
  "is_system": true
}