Get Room Details

getRoomDetails() method helps to retrieve information about specific roomId.

import { API } from '@huddle01/server-sdk/api';
const roomDetails = async () => {
  const api = new API({
    apiKey: process.env.API_KEY!,
  const roomDetails = await api.getRoomDetails({
    roomId: 'YOUR_ROOM_ID',
  return roomDetails?.data;


getRoomDetails() will return all details about room, if it's token gated it will also return tokenGatingInfo.

roomIdstringUnique identifier of the room
appDataanyCustom data
titlestringTitle of the room
descriptionstringDescription of the room
meetingLinkstringMeeting link of the room
startTimestringStart time of the room
expiryTimestringExpiry time of the room
videoOnEntrybooleanVideo on entry
muteOnEntrybooleanMute on entry
roomLockedbooleanBoolean to check if room is locked or not
hostWalletAddressstring[]List of host wallet addresses
tokenGatingInfoObjectToken gating info
roomType'VIDEO' | 'AUDIO'Room type
roomSize'NORMAL' | 'LARGE'Room size
tokenTypestringType of token such as ERC20, ERC721 etc
chainstringChain such as Ethereum, BSC, Polygon, etc
contractAddressstringContract address of token
conditionTypestringCondition type such as COLLECT_POST, FOLLOW_HANDLE, etc
conditionValuestringCondition value such as token id for ERC1155
   "data": {
      "roomId": "emo-orrj-uvh",
      "appData": null,
      "title": "Test Meeting",
      "description": null,
      "meetingLink": "",
      "startTime": null,
      "expiryTime": null,
      "videoOnEntry": false,
      "muteOnEntry": false,
      "roomLocked": false,
      "hostWalletAddress": [],
      "tokenGatingInfo": {
        "id": "TOKEN_GATING_ID",
        "tokenGatingConditions": [
            "id": "TOKEN_GATING_CONDITIONS_ID",
            "tokenType": "TOKEN_TYPE",
            "chain": "CHAIN",
            "contractAddress": "CONTRACT_ADDRESS",
            "conditionType": null,
            "conditionValue": null,
      "roomType": "VIDEO | AUDIO",
      "roomSize": "NORMAL | LARGE"
Audio/Video Infrastructure designed for the developers to empower them ship simple yet powerful Audio/Video Apps.
Copyright © 2024 Graphene 01, Inc. All Rights Reserved.