Skip to main content
GET
/
api
/
content
/
videofiles
/
{id}
Get one VideoFile
curl --request GET \
  --url https://spaces.nexudus.com/api/content/videofiles/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "VideoFileName": "<string>",
  "NewVideoUrl": "<string>",
  "ClearVideoFile": true,
  "FileSizeBytes": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A VideoFile represents an uploaded video stored in the system. Video files can be used in courses, community content, or other areas of the platform.

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 VideoFile-Read role.

Path Parameters

id
integer
required
The Id of the VideoFile record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/videofiles/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 file.
Description
string
Free-text description of this video file.
VideoFileName
string
Current file name of the video (read-only; upload via the corresponding URL field).
NewVideoUrl
string
URL of a new file to upload as the video.
ClearVideoFile
boolean
Set to true to remove the current video file.
FileSizeBytes
integer
The file size bytes value for this video file.
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,
  "VideoFileName": null,
  "NewVideoUrl": null,
  "ClearVideoFile": null,
  "FileSizeBytes": null,
  "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": "VideoFile Example",
  "LocalizationDetails": null,
  "CustomFields": null
}