This document is generated by Aladia.

Aladia API

List All Notifications

Developing

GET

/notifications

This endpoint retrieves a list of notifications received by the user.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
  "data": [
    {
      "id": "6736f117716f8ca14d87cd57",
      "senders": [
        {
          "id": "6735ba25ed7c99d51b614cb4",
          "type": "profile",
          "createdAt": "2024-11-15T06:58:31.163Z",
          "fullName": "Surafel Workayehu",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": true
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "post-create",
      "url": "http://localhost:3000/user/hub/6735ae94ca5d8c80893ee412/feed?postId=6736f116e83ce9ff65d2d47a",
      "entityIds": [
        "6736f116e83ce9ff65d2d47a"
      ],
      "placeholders": {
        "text": "<p>checking sample image</p>",
        "file": {
          "metadata": {
            "mimetype": "image/png",
            "size": 33767,
            "name": "Screenshot 2024-05-13 130600.png"
          },
          "url": "https://storage.googleapis.com/820b55f3-d040-4527-a27f-e2962903acad/6736f115e83ce9ff65d2d3bd?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=storage%40backend-test-aladia.iam.gserviceaccount.com%2F20241115%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20241115T065830Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=4afec41ada6a79d2b45841e3c6d396d2b049954e07316dbcb9589a120ea45214d85c52d928a46b77805756fb6cebe59ef09ac50c96c977b94ecd77b1a705043333484c700d90b4796cd95f77d6afa484ea50b2d9a1b0a92d87da7906cd4a0e77764e655910dd866f832a7b8049f73fbc383850b6206007c87cfc8bc76ad1873becb6b2f30b79d63607a5a2b4bade7c4b85ea07e2ece01cc7b31c6ab3b86f899b099e29837633d5bbd21f1df85dd80bb53783f7f7ff89acf853e62aa6dd6bc6220e184387983a1d5485056fd403ed598ee8e52341bd9b27ffec53d39783033f6367ef7aa40f609bc1341e5e8bb13797fad2f75d4e3a17bbc057e4a53b71916874",
          "fileId": "6736f115e83ce9ff65d2d3bd"
        },
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": null,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-11-15T06:58:31.165Z",
      "updatedAt": "2024-11-15T06:58:31.165Z"
    },
    {
      "id": "6736eef6f569fbb9e2822a2b",
      "senders": [
        {
          "id": "6735ba25ed7c99d51b614cb4",
          "type": "profile",
          "createdAt": "2024-11-15T06:49:26.865Z",
          "fullName": "Surafel Workayehu",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": true
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "post-create",
      "url": "http://localhost:3000/user/hub/6735ae94ca5d8c80893ee412/feed?postId=6736eef4f569fbb9e2822a1c",
      "entityIds": [
        "6736eef4f569fbb9e2822a1c"
      ],
      "placeholders": {
        "text": "Checking here",
        "file": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": null,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-11-15T06:49:26.878Z",
      "updatedAt": "2024-11-15T06:49:26.878Z"
    },
    {
      "id": "67365864505a503217cc1f4a",
      "senders": [
        {
          "id": "67365799505a503217cc1bb2",
          "type": "profile",
          "createdAt": "2024-11-14T20:07:00.572Z",
          "fullName": "Yohannes Bekele",
          "image": "https://storage.googleapis.com/de71ba5c-00a4-4f44-bfe0-943f4ff81a4f/6736579c505a503217cc1bbc?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=storage%40backend-test-aladia.iam.gserviceaccount.com%2F20241115%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20241115T062228Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=2270739bb67c5156e0161ee86fed69c053f8456b7b9aad1f1777b6c1b9878d9cc651dc08b6037dd6c65801f8d5079b165a0b8e4b74a845071acf79aeff7bffcae158ef8b3d7574bd58ebca2775d6d8a92316e63a84b7043b81d7d8c96271c64133766a66c8a64e5950b281a224270cff0cffc211b260b6f01190d3ed59a83cb50a915145e69e6d6aaffa16b0123a8e133933eff43990c10f230b14451c136cb7a6b65eafa613adad51b44a73c4596a3510782ba5cc63c17150570972ca48035606d703284636d4f724f5aa8fc96c4d1c2c45ed380e330243b432874ba2e45098d9b561b1d6a995e1396ed0c68965db45a5818ab9d3d836eb9dee5825940965e9",
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": false
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "organization-member-invite",
      "url": "http://localhost:3000",
      "entityIds": [
        "673657ab9b22a5fa7f9508b0"
      ],
      "placeholders": {
        "text": "Yohannes",
        "file": null,
        "reactionType": null,
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoib3JnYW5pemF0aW9uLWFkbWluIiwiaWF0IjoxNzMxNjE0ODIwLCJleHAiOjIzMzY0MTQ4MjAsImF1ZCI6ImxvY2FsaG9zdDozMDAwIiwiaXNzIjoibG9jYWxob3N0OjMwMDAifQ.sAlbHjG9QYJDd0SzUA3dk0JttdkCnzHRfliWuOzgykM",
        "name": null,
        "invitationStatus": "accepted",
        "status": null,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-11-14T20:07:00.575Z",
      "updatedAt": "2024-11-14T20:07:00.575Z"
    },
    {
      "id": "67361618192fbf9e79efd955",
      "senders": [
        {
          "id": "6735ba25ed7c99d51b614cb4",
          "type": "profile",
          "createdAt": "2024-11-14T15:24:08.522Z",
          "fullName": "Surafel Workayehu",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": true
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "calendar-member-accept-invite",
      "url": "http://localhost:3000/user/hub/6735ae94ca5d8c80893ee412/calendar?calendarId=67361576192fbf9e79efd0d7",
      "entityIds": [
        "67361576192fbf9e79efd0d7"
      ],
      "placeholders": {
        "text": "Checking night night",
        "file": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": null,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-11-14T15:24:08.530Z",
      "updatedAt": "2024-11-14T15:24:08.530Z"
    },
    {
      "id": "6735c5c5ed7c99d51b628ede",
      "senders": [
        {
          "id": "6735ba25ed7c99d51b614cb4",
          "type": "profile",
          "createdAt": "2024-11-14T09:41:25.080Z",
          "fullName": "Surafel Workayehu",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": true
        }
      ],
      "senderCount": 0,
      "isRead": true,
      "type": "organization-member-accept-invite",
      "url": "http://localhost:3000",
      "entityIds": [
        "6735c3cc2b47bf97b92ea2ae"
      ],
      "placeholders": {
        "text": "2024-11-14T09:33:00.659Z",
        "file": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": null,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-11-14T09:41:25.084Z",
      "updatedAt": "2024-11-14T09:41:25.084Z"
    },
    {
      "id": "6735c3cded7c99d51b625fd8",
      "senders": [
        {
          "id": "6735c3cc2b47bf97b92ea2ae",
          "type": "organization",
          "createdAt": "2024-11-14T09:33:01.430Z",
          "fullName": "2024-11-14T09:33:00.659Z",
          "image": null,
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": null
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "organization-create",
      "url": "http://localhost:3000/organization/hub/6735ae94ca5d8c80893ee412/profile",
      "entityIds": [
        "6735c3cc2b47bf97b92ea2ae"
      ],
      "placeholders": {
        "text": "2024-11-14T09:33:00.659Z",
        "file": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": null,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-11-14T09:33:01.438Z",
      "updatedAt": "2024-11-14T09:33:01.438Z"
    },
    {
      "id": "6735b1e1ed7c99d51b607b92",
      "senders": [
        {
          "id": "6735ae94ca5d8c80893ee412",
          "type": "profile",
          "createdAt": "2024-11-14T08:16:33.893Z",
          "fullName": "Surafel Workayehu",
          "image": "https://storage.googleapis.com/ea5f19ee-8368-4f68-b616-640f495b6b57/6735ae96ca5d8c80893ee43e?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=storage%40backend-test-aladia.iam.gserviceaccount.com%2F20241115%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20241115T062538Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=79c65a67fca3fcba30f8fd633c4327820be1b25b3efbb26eaf25f91e8a33eef5d194e4bd910abc752791f62a601b6f28cbd22522c49703f6c9e681f6b47333e51de1a1b664f10445217d5e731ad616511c4a52c39158de6a5f362eace03cd9f42b9d2c85fa7b91ccd753f9c01edef78154c173d83db174e88dadfd07ceb97e9edbba6c42b7f4d7f767e348642b19de4641e5bfe5e992b327c2b3659b1fdc1bce03220e44afcbbd0dcd28f6262802ce127a10f1d45aec8d86fcafe02c390ff55367d987a3353d79d037269119c97c875bf88499626750c84ab970b88335da0f89d75be732c4494c4b84b5fc5f80066e93b3462ca128b6c150769a5ac246da8d7d",
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": true
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "become-teacher",
      "url": "http://localhost:3000",
      "entityIds": [
        "6735ae94ca5d8c80893ee412"
      ],
      "placeholders": {
        "text": "",
        "file": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": null,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-11-14T08:16:33.895Z",
      "updatedAt": "2024-11-14T08:16:33.895Z"
    },
    {
      "id": "6735ae95ca5d8c80893ee417",
      "senders": [
        {
          "id": "6735ae94ca5d8c80893ee412",
          "type": "profile",
          "createdAt": "2024-11-14T08:02:29.134Z",
          "fullName": "Surafel Workayehu",
          "image": "https://storage.googleapis.com/ea5f19ee-8368-4f68-b616-640f495b6b57/6735ae96ca5d8c80893ee43e?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=storage%40backend-test-aladia.iam.gserviceaccount.com%2F20241115%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20241115T062538Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=79c65a67fca3fcba30f8fd633c4327820be1b25b3efbb26eaf25f91e8a33eef5d194e4bd910abc752791f62a601b6f28cbd22522c49703f6c9e681f6b47333e51de1a1b664f10445217d5e731ad616511c4a52c39158de6a5f362eace03cd9f42b9d2c85fa7b91ccd753f9c01edef78154c173d83db174e88dadfd07ceb97e9edbba6c42b7f4d7f767e348642b19de4641e5bfe5e992b327c2b3659b1fdc1bce03220e44afcbbd0dcd28f6262802ce127a10f1d45aec8d86fcafe02c390ff55367d987a3353d79d037269119c97c875bf88499626750c84ab970b88335da0f89d75be732c4494c4b84b5fc5f80066e93b3462ca128b6c150769a5ac246da8d7d",
          "isFollowing": null,
          "mutualFollow": null,
          "isOnline": true
        }
      ],
      "senderCount": 0,
      "isRead": false,
      "type": "profile-incomplete",
      "url": "http://localhost:3000/user/hub/6735ae94ca5d8c80893ee412/profile",
      "entityIds": [
        "6735ae94ca5d8c80893ee412"
      ],
      "placeholders": {
        "text": "",
        "file": null,
        "reactionType": null,
        "token": null,
        "name": null,
        "invitationStatus": null,
        "status": null,
        "quantity": null,
        "currentInstallment": null,
        "totalInstallment": null,
        "entityType": null
      },
      "createdAt": "2024-11-14T08:02:29.138Z",
      "updatedAt": "2024-11-14T08:02:29.138Z"
    }
  ],
  "cursor": {
    "next": null,
    "prev": null,
    "totalItems": 8
  }
}

Request

Query Params

limit

integer

optional

Number of documents per page in the response

Default:

string

optional

Next token cursor, to navigate towards the next page

string

optional

Previous token cursor, to navigate towards the previous page

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}]

required

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-12 09:41:54

Delete a Notification

Search Notifications