Room Details API
This API lets you retrieve the room details using either the room ID or the title of the room.
Using RoomId
https://api.huddle01.com/api/v2/sdk/rooms/room-details/{roomId}
The Room Details API is a useful tool for retrieving information about a specific meeting room. By passing in the roomId as a parameter, you can easily access the details of a previously created room.
This API is especially useful if you need to retrieve information about a room for administrative purposes or if you want to display information about a room to its participants. Overall, the Room Details API is a valuable resource for accessing information about your meeting rooms and can be used in a variety of scenarios to enhance your experience with Huddle01.
/rooms/room-details/{roomId}
Room Details API
The API supports a POST request with the following required parameters:
roomId
- The RoomId of the room, for which you need to get the details.
const response = await axios.get(
'https://api.huddle01.com/api/v2/sdk/rooms/room-details/{roomId}',
{
headers: {
'x-api-key': {{API_KEY}},
},
}
);
Upon success, the API will return a response with the following fields:
roomId
- The room ID of the newly created room.roomLocked
- A boolean value indicating if the room is locked.metadata
- An object containing the metadata of the room, including the title and other custom metadata.
In case of an error, the API will return an error message with a corresponding status code.
{
"roomId": "nvw-fxtj-gha",
"roomLocked": true,
"metadata": {
"hosts": [],
"title": "",
"roomType": "video",
"meetingLink": "https://akmo.huddle01.com/voy-kpsa-hpo"
}
}