Skip to main content
GET
/
api
/
community
/
videorooms
/
{id}
Get one VideoRoom
curl --request GET \
  --url https://spaces.nexudus.com/api/community/videorooms/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "NumberOfParticipants": 123,
  "Active": true,
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A VideoRoom represents a virtual meeting room for video conferencing. Video rooms enable online meetings between members and can be integrated with booking resources.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the VideoRoom-Read role.

​
Path Parameters

​
id
integer
required
The Id of the VideoRoom record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/community/videorooms/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
Name
string
The name value for this video room.
​
Description
string
Free-text description of this video room.
​
ImageFileName
string
Current file name of the image (read-only; upload via the corresponding URL field).
​
NewImageUrl
string
URL of a new file to upload as the image.
​
ClearImageFile
boolean
Set to true to remove the current image file.
​
NumberOfParticipants
integer
The number of participants value for this video room.
​
Active
boolean
Whether this video room is currently active.
​
OnlyForContacts
boolean
Whether only for contacts is enabled.
​
OnlyForMembers
boolean
Whether only for members is enabled.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "Name": "",
  "Description": null,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "NumberOfParticipants": 0,
  "Active": false,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "VideoRoom Example",
  "LocalizationDetails": null,
  "CustomFields": null
}