Liveblocks icon

Liveblocks

Call the Liveblocks REST API (rooms, comments, feeds, Yjs, AI, and more)

User → Get Room Subscription Settings

AI-generated

Summary

Retrieve the subscription settings of a specified user for a given Liveblocks room by providing the room ID and user ID.

Inputs

  • Room ID (required) — The identifier of the Liveblocks room for which to get the user's subscription settings.
  • User ID (required) — The identifier of the user whose subscription settings for the specified room are to be retrieved.
  • Include Request in Error — Whether to include detailed request information in error responses to aid debugging.

Output shape

A single record representing the user's subscription settings for the specified room.

The operation returns the user's subscription settings as a structured object. If the API call fails, error details may optionally include request information based on the 'Include Request in Error' input.

Links

Discussion