Skip to main content
GET
/
api
/
content
/
videofiles
Search VideoFiles
curl --request GET \
  --url https://spaces.nexudus.com/api/content/videofiles \
  --header 'Authorization: Basic <encoded-value>'
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
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-List role.

Query Parameters

Pagination & Sorting

page
integer
default:"1"
The page number to retrieve.
size
integer
default:"25"
The number of records per page.
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
dir
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

VideoFile_Business
integer
Filter by iD of the business linked to this record.
VideoFile_Name
string
Filter by the name value for this video file.
VideoFile_Description
string
Filter by free-text description of this video file.
VideoFile_VideoFileName
string
Filter by current file name of the video (read-only; upload via the corresponding URL field).
VideoFile_NewVideoUrl
string
Filter by uRL of a new file to upload as the video.
VideoFile_ClearVideo
boolean
Filter by set to true to remove the current video file.
VideoFile_FileSizeBytes
integer
Filter by the file size bytes value for this video file.

Range Filters

from_VideoFile_FileSizeBytes
integer
Filter by the file size bytes value for this video file greater than or equal to this value.
to_VideoFile_FileSizeBytes
integer
Filter by the file size bytes value for this video file less than or equal to this value.
from_VideoFile_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
to_VideoFile_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
from_VideoFile_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
to_VideoFile_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/content/videofiles?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/content/videofiles?VideoFile_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/content/videofiles?from_VideoFile_UpdatedOn=2025-01-01T00:00&to_VideoFile_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records
VideoFile[]
The list of VideoFile records matching the query. See the Get one VideoFile endpoint for the full list of properties returned for each record.
CurrentPage
integer
Current page number.
CurrentPageSize
integer
Number of records per page.
CurrentOrderField
string
The field used for sorting.
CurrentSortDirection
integer
The sort direction (0 = ascending, 1 = descending).
FirstItem
integer
Index of the first item on the current page.
LastItem
integer
Index of the last item on the current page.
TotalItems
integer
Total number of matching records across all pages.
TotalPages
integer
Total number of pages.
HasNextPage
boolean
Whether there is a next page of results.
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}