Notifications

Get user room subscription settings

This endpoint returns the list of a user's room subscription settings. Corresponds to liveblocks.getUserRoomSubscriptionSettings.

get/users/{userId}/room-subscription-settings

Request

userIdstring required

ID of the user

Example:user-123

startingAfterstring

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

Example:eyJjcmVhdGVkQXQiOjE2NjAwMDA5ODgxMzd9

limitinteger

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

Example:20

organizationIdstring

The organization ID to filter room subscription settings for.

Example:org_123456789

Success. Returns the list of the user's room subscription settings.

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.

{
  "nextCursor": null,
  "data": [
    {
      "threads": "all",
      "textMentions": "mine",
      "roomId": "my-room-id"
    }
  ]
}