Notifications

Get all inbox notifications

Changed on

This endpoint returns all the user’s inbox notifications. Corresponds to liveblocks.getInboxNotifications.

get/users/{userId}/inbox-notifications

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/users/{userId}/inbox-notifications
  • Auth: none declared

Path parameters

userIdstring required

ID of the user

Example:user-123

Query parameters

organizationIdstring

The organization ID to filter notifications for.

Example:org_123456789
querystring

Query to filter notifications. You can filter by unread, for example, unread:true.

Example:metadata["color"]:"blue"
limitinteger

A limit on the number of inbox notifications to be returned. The limit can range between 1 and 50, and defaults to 50.

Example:20
startingAfterstring

A cursor used for pagination. Get the value from the nextCursor response of the previous page.

Example:eyJjcmVhdGVkQXQiOjE2NjAwMDA5ODgxMzd9

Response

Success. Returns the list of inbox notifications for the user.

nextCursorstring nullable required

A cursor to use for pagination. Pass this value as startingAfter to get the next page of results. null if there are no more results.

Example response

{
  "nextCursor": null,
  "data": [
    {
      "kind": "thread",
      "id": "in_abc123",
      "roomId": "my-room-id",
      "threadId": "th_abc123",
      "notifiedAt": "2024-01-15T10:30:00.000Z",
      "readAt": null
    }
  ]
}

Changes

  • 27df578098d7Revision changes
    • info

      added the optional property /// to the response with the status

  • 77cd6a75b2b7Revision changes
    • breaking

      for the query request parameter limit, the type changed from number to integer

    • breaking

      the response's body type changed from array to object for status

    • info

      api operation id get-users-userId-inboxNotifications removed and replaced with get-inbox-notifications

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status