Retrieve a Notification

This endpoint retrieves a notification using the given ID.

{ "id": "66fd5d782d98b65f16cc0622", "senders": [ { "id": "66fd5d592d98b65f16cc05e8", "type": "profile", "createdAt": "2024-10-02T14:49:28.826Z", "fullName": "Ezra Yeneneh", "image": null, "isFollowing": null, "mutualFollow": null, "isOnline": false } ], "senderCount": 0, "isRead": false, "type": "profile-incomplete", "url": "http://localhost:3000", "entityIds": [ "66fd5d592d98b65f16cc05e8" ], "placeholders": { "text": "", "image": null, "reactionType": null, "token": null, "name": null, "invitationStatus": null, "status": null, "quantity": null, "currentInstallment": null, "totalInstallment": null, "entityType": null }, "createdAt": "2024-10-02T14:49:28.828Z", "updatedAt": "2024-10-02T14:49:28.828Z" }

Responses

🟢200Success

application/json

Body

string

required

The unique identifier for the notification settings

senders

array[object (Sender.rto) {8}]

required

Array of Notification senders profile information(the latest will be the last sender in the array)

string

required

id of the user

type

enum<string>

required

either profile or organization

Allowed values:

profileorganization

fullName

string

required

fullName of the user

image

string | null

optional

image of the user

isFollowing

boolean | null

optional

check if the user still follows (latest value of mutualFollow)

mutualFollow

boolean | null

optional

This field is used in follow notifications to specify if the follow is mutual. "true if follow eachother"

isOnline

boolean | null

optional

A public boolean indicating whether the owner is currently online.

createdAt

string

required

A string representing the timestamp when the sender entity was created.

senderCount

number

required

Number of sender count when it's greater than 2 else it will be 0

isRead

boolean

required

A boolean indicating whether the notification has been read (true or false).

type

string

required

A NotificationType enum or type, representing the type or category of the notification.

url

string

required

A string representing the URL related to the notification.

entityIds

array[string]

required

An array of strings representing the IDs of entities associated with this notification.

placeholders

object (Placeholders.rto)

required

placeholder for notification template

text

string

required

Text content for notification

file

object | null

required

file placeholder

reactionType

string | null

optional

Reaction type for reaction related notifications

token

string | null

optional

A string used for authentication or authorization.

name

string | null

optional

A string for the name of a user or entity

status

boolean | null

optional

A boolean indicating the invitation status.

quantity

number | null

optional

A number representing an amount or count.

currentInstallment

number | null

optional

A number representing the current installment in a sequence.

totalInstallment

number | null

optional

A number representing the total number of installments.

entityType

string | null

optional

A string indicating the type of entity involved.

createdAt

string

required

A string representing the timestamp of when the notification was created.

updatedAt

string

required

A string representing the timestamp of when the notification was last updated.

🟠404Not Found

🔴500Server Error

🟠401Unauthorized

Retrieve a Notification

Request

Responses