This document is generated by Aladia.

Search Notifications

Developing

GET

/notifications/search

This endpoint retrieves a list of notifications that match the given query (read/unread).
Notifications are sorted by createdAt date.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/notifications/search?read&limit=50' \
--header 'apikey: '

Response Example

{
  "data": [
    {
      "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"
    },
    {
      "id": "66fd5de82d98b65f16cc0778",
      "senders": [
        {
          "id": "66fd5d592d98b65f16cc05e8",
          "type": "profile",
          "createdAt": "2024-10-02T14:51:20.050Z",
          "fullName": "Ezra Yeneneh",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "course-generation-success",
      "url": "http://localhost:3000/courses/66fd5dc02d98b65f16cc066f",
      "entityIds": [
        "66fd5dc02d98b65f16cc066f"
      ],
      "placeholders": {
        "text": "physics",
        "image": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": true,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-10-02T14:51:20.053Z",
      "updatedAt": "2024-10-02T14:51:20.053Z"
    },
    {
      "id": "66fd5eae2d98b65f16cc0fbc",
      "senders": [
        {
          "id": "66fd5d592d98b65f16cc05e8",
          "type": "profile",
          "createdAt": "2024-10-02T14:54:38.581Z",
          "fullName": "Ezra Yeneneh",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "course-generation-success",
      "url": "http://localhost:3000/courses/66fd5dc02d98b65f16cc066f",
      "entityIds": [
        "66fd5dc02d98b65f16cc066f"
      ],
      "placeholders": {
        "text": "physics",
        "image": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": true,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-10-02T14:54:38.586Z",
      "updatedAt": "2024-10-02T14:54:38.586Z"
    },
    {
      "id": "66fd5f6568025c48acaa0a9c",
      "senders": [
        {
          "id": "66fd5d592d98b65f16cc05e8",
          "type": "profile",
          "createdAt": "2024-10-02T14:57:41.199Z",
          "fullName": "Ezra Yeneneh",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "course-generation-success",
      "url": "http://localhost:3000/courses/66fd5dc02d98b65f16cc066f",
      "entityIds": [
        "66fd5dc02d98b65f16cc066f"
      ],
      "placeholders": {
        "text": "physics",
        "image": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": true,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-10-02T14:57:41.204Z",
      "updatedAt": "2024-10-02T14:57:41.204Z"
    },
    {
      "id": "66fd612d897a2dbf45815a83",
      "senders": [
        {
          "id": "66fd5d592d98b65f16cc05e8",
          "type": "profile",
          "createdAt": "2024-10-02T15:05:17.632Z",
          "fullName": "Ezra Yeneneh",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "course-generation-success",
      "url": "http://localhost:3000/courses/66fd5dc02d98b65f16cc066f",
      "entityIds": [
        "66fd5dc02d98b65f16cc066f"
      ],
      "placeholders": {
        "text": "physics",
        "image": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": true,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-10-02T15:05:17.635Z",
      "updatedAt": "2024-10-02T15:05:17.635Z"
    },
    {
      "id": "66fd61b2c1f9c307bb0f36cb",
      "senders": [
        {
          "id": "66fd5d592d98b65f16cc05e8",
          "type": "profile",
          "createdAt": "2024-10-02T15:07:30.808Z",
          "fullName": "Ezra Yeneneh",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "course-generation-success",
      "url": "http://localhost:3000/courses/66fd5dc02d98b65f16cc066f",
      "entityIds": [
        "66fd5dc02d98b65f16cc066f"
      ],
      "placeholders": {
        "text": "physics",
        "image": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": true,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-10-02T15:07:30.811Z",
      "updatedAt": "2024-10-02T15:07:30.811Z"
    },
    {
      "id": "66fd6279d8e562dbef985ac9",
      "senders": [
        {
          "id": "66fd5d592d98b65f16cc05e8",
          "type": "profile",
          "createdAt": "2024-10-02T15:10:49.390Z",
          "fullName": "Ezra Yeneneh",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "course-generation-success",
      "url": "http://localhost:3000/courses/66fd5dc02d98b65f16cc066f",
      "entityIds": [
        "66fd5dc02d98b65f16cc066f"
      ],
      "placeholders": {
        "text": "physics",
        "image": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": true,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-10-02T15:10:49.392Z",
      "updatedAt": "2024-10-02T15:10:49.392Z"
    },
    {
      "id": "66fd6745fe072420cfea61a7",
      "senders": [
        {
          "id": "66fd5d592d98b65f16cc05e8",
          "type": "profile",
          "createdAt": "2024-10-02T15:31:17.720Z",
          "fullName": "Ezra Yeneneh",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "course-generation-success",
      "url": "http://localhost:3000/courses/66fd5dc02d98b65f16cc066f",
      "entityIds": [
        "66fd5dc02d98b65f16cc066f"
      ],
      "placeholders": {
        "text": "physics",
        "image": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": true,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-10-02T15:31:17.724Z",
      "updatedAt": "2024-10-02T15:31:17.724Z"
    },
    {
      "id": "66fd6773d286bc97b7fd2907",
      "senders": [
        {
          "id": "66fd5d592d98b65f16cc05e8",
          "type": "profile",
          "createdAt": "2024-10-02T15:32:03.546Z",
          "fullName": "Ezra Yeneneh",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "course-generation-success",
      "url": "http://localhost:3000/courses/66fd5dc02d98b65f16cc066f",
      "entityIds": [
        "66fd5dc02d98b65f16cc066f"
      ],
      "placeholders": {
        "text": "physics",
        "image": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": true,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-10-02T15:32:03.551Z",
      "updatedAt": "2024-10-02T15:32:03.551Z"
    },
    {
      "id": "66fd67bcdfe498e84a9d641f",
      "senders": [
        {
          "id": "66fd5d592d98b65f16cc05e8",
          "type": "profile",
          "createdAt": "2024-10-02T15:33:16.578Z",
          "fullName": "Ezra Yeneneh",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "course-generation-success",
      "url": "http://localhost:3000/courses/66fd5dc02d98b65f16cc066f",
      "entityIds": [
        "66fd5dc02d98b65f16cc066f"
      ],
      "placeholders": {
        "text": "physics",
        "image": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": true,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-10-02T15:33:16.581Z",
      "updatedAt": "2024-10-02T15:33:16.581Z"
    }
  ],
  "cursor": {
    "next": "eyJpZCI6IjY2ZmQ2N2JjZGZlNDk4ZTg0YTlkNjQxZiIsImRpcmVjdGlvbiI6ImFzYyJ9",
    "prev": null,
    "totalItems": 191
  }
}

Request

Query Params

read

boolean

required

limit

integer

optional

Number of documents per page in the response

Default:

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

cursor

object (Cursor)

required

totalItems

integer

required

Number of total items

string | null

required

Previous token cursor, to navigate towards the previous page

string | null

required

Next token cursor, to navigate towards the next page

data

array [object {10}]

optional

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)

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

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.

Modified at 2025-04-10 07:06:05

List All Notifications

Retrieve Grouped Senders