VideoFiles
Get one VideoFile
Retrieve a single VideoFile record by its Id.
GET
Get one VideoFile
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
integer
required
The Id of the VideoFile record to retrieve.
Code Examples
Response
200
integer
ID of the business linked to this record.
string
The name value for this video file.
string
Free-text description of this video file.
string
Current file name of the video (read-only; upload via the corresponding URL field).
string
URL of a new file to upload as the video.
boolean
Set to true to remove the current video file.
integer
The file size bytes value for this video file.
integer
Unique record identifier.
string
UUID of the record.
string
Date and time the record was created (ISO 8601).
string
Date and time the record was last updated (ISO 8601).
string
Email of the user who last updated this record.
boolean
Whether the record was recently created.
string
External system identifier.
Example Response
Get one VideoFile