Notifications

List my notifications

get

Returns the authenticated user's notifications.

Query parameters

pagenumber · nullableOptional

limitnumber · nullableOptional

sortBystringOptional

sortOrderstring · enumOptionalPossible values:

unreadOnlyboolean · nullableOptional

Responses

200

200

application/json

unreadCountnumberRequired

get/network.cosmik.notification.list

HTTPcURLJavaScriptPython

GET /xrpc/network.cosmik.notification.list HTTP/1.1
Host: api.semble.so
Accept: */*

200

200

{
  "notifications": [
    {
      "id": "text",
      "user": {
        "id": "text",
        "name": "text",
        "handle": "text",
        "avatarUrl": "text",
        "bannerUrl": "text",
        "description": "text",
        "isFollowing": true,
        "isSubscribed": true,
        "subscriptionScopes": [
          "CARD"
        ],
        "followsYou": true,
        "followerCount": 1,
        "followingCount": 1,
        "followedCollectionsCount": 1,
        "urlCardCount": 1,
        "collectionCount": 1,
        "connectionCount": 1,
        "connectionsByType": {
          "total": 1,
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "labels": [
          {
            "$type": "com.atproto.label.defs#label",
            "ver": 1,
            "src": "text",
            "uri": "text",
            "cid": "text",
            "val": "text",
            "neg": true,
            "cts": "text",
            "exp": "text",
            "sig": null
          }
        ]
      },
      "createdAt": "text",
      "type": "USER_ADDED_YOUR_CARD",
      "read": true,
      "card": {
        "id": "text",
        "type": "URL",
        "url": "text",
        "uri": "text",
        "cardContent": {
          "url": "text",
          "title": "text",
          "description": "text",
          "author": "text",
          "publishedDate": "text",
          "siteName": "text",
          "imageUrl": "text",
          "type": "text",
          "retrievedAt": "text",
          "doi": "text",
          "isbn": "text"
        },
        "libraryCount": 1,
        "urlLibraryCount": 1,
        "urlInLibrary": true,
        "urlConnectionCount": 1,
        "urlIsConnected": true,
        "createdAt": "text",
        "updatedAt": "text",
        "author": {
          "id": "text",
          "name": "text",
          "handle": "text",
          "avatarUrl": "text",
          "bannerUrl": "text",
          "description": "text",
          "isFollowing": true,
          "isSubscribed": true,
          "subscriptionScopes": [
            "CARD"
          ],
          "followsYou": true,
          "followerCount": 1,
          "followingCount": 1,
          "followedCollectionsCount": 1,
          "urlCardCount": 1,
          "collectionCount": 1,
          "connectionCount": 1,
          "connectionsByType": {
            "total": 1,
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "labels": [
            {
              "$type": "com.atproto.label.defs#label",
              "ver": 1,
              "src": "text",
              "uri": "text",
              "cid": "text",
              "val": "text",
              "neg": true,
              "cts": "text",
              "exp": "text",
              "sig": null
            }
          ]
        },
        "note": {
          "id": "text",
          "text": "text"
        }
      },
      "collections": [
        {
          "id": "text",
          "uri": "text",
          "name": "text",
          "author": {
            "id": "text",
            "name": "text",
            "handle": "text",
            "avatarUrl": "text",
            "bannerUrl": "text",
            "description": "text",
            "isFollowing": true,
            "isSubscribed": true,
            "subscriptionScopes": [
              "CARD"
            ],
            "followsYou": true,
            "followerCount": 1,
            "followingCount": 1,
            "followedCollectionsCount": 1,
            "urlCardCount": 1,
            "collectionCount": 1,
            "connectionCount": 1,
            "connectionsByType": {
              "total": 1,
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "labels": [
              {
                "$type": "com.atproto.label.defs#label",
                "ver": 1,
                "src": "text",
                "uri": "text",
                "cid": "text",
                "val": "text",
                "neg": true,
                "cts": "text",
                "exp": "text",
                "sig": null
              }
            ]
          },
          "description": "text",
          "accessType": "OPEN",
          "cardCount": 1,
          "createdAt": "text",
          "updatedAt": "text",
          "isFollowing": true,
          "isSubscribed": true,
          "subscriptionScopes": [
            "CARD"
          ],
          "followerCount": 1
        }
      ]
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "totalCount": 1,
    "hasMore": true,
    "limit": 1
  },
  "unreadCount": 1
}

Get unread notification count

get

Returns the number of unread notifications for the authenticated user.

Responses

200

200

application/json

unreadCountnumberRequired

get/network.cosmik.notification.getUnreadCount

HTTPcURLJavaScriptPython

GET /xrpc/network.cosmik.notification.getUnreadCount HTTP/1.1
Host: api.semble.so
Accept: */*

200

200

{
  "unreadCount": 1
}

Mark notifications as read

post

Marks one or more notifications as read by ID.

Body

application/json

notificationIdsstring[]Required

Responses

200

200

application/json

markedCountnumberRequired

post/network.cosmik.notification.markRead

HTTPcURLJavaScriptPython

POST /xrpc/network.cosmik.notification.markRead HTTP/1.1
Host: api.semble.so
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "notificationIds": [
    "text"
  ]
}

200

200

{
  "markedCount": 1
}

Mark all notifications as read

post

Marks all of the authenticated user's notifications as read.

Body

application/json

objectOptional

Responses

200

200

application/json

markedCountnumberRequired

post/network.cosmik.notification.markAllRead

HTTPcURLJavaScriptPython

POST /xrpc/network.cosmik.notification.markAllRead HTTP/1.1
Host: api.semble.so
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

200

{
  "markedCount": 1
}