Skip to main content
GET
/
api
/
v1
/
room
/
{id}
Get room details
curl --request GET \
  --url https://api.noux.app/api/v1/room/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'authorization: <authorization>'
{
  "roomId": "<string>",
  "roomName": "<string>",
  "languageCode": "<string>",
  "theme": {
    "id": "<string>",
    "name": "<string>"
  },
  "owner": {
    "id": "<string>",
    "email": "jsmith@example.com",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "editors": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "firstName": "<string>",
      "lastName": "<string>"
    }
  ],
  "numInvited": 123,
  "numJoinedVisitors": 123,
  "numComments": 123
}

Authorizations

Authorization
string
header
required

Noux API key from your integration settings

Headers

authorization
string
required

Bearer token with Noux API key

Path Parameters

id
string
required

The room ID to retrieve

Response

Room details retrieved successfully

roomId
string
required
roomName
string
required
languageCode
string
required

Language code for the room. Defaults to "en" (English) if not set.

theme
object
required

Theme applied to the room. If null, the room is using the Noux default theme.

owner
object
required
editors
object[]
required
numInvited
number
required

Number of invited visitors (pending or accepted invitations)

numJoinedVisitors
number
required

Number of visitors who have joined the room

numComments
number
required

Total number of comments in the room