VideoFiles
Search VideoFiles
Search and list VideoFile records with filtering, sorting, and pagination.
GET
Search VideoFiles
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
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the business linked to this record.
Filter by the name value for this video file.
Filter by free-text description of this video file.
Filter by current file name of the video (read-only; upload via the corresponding URL field).
Filter by uRL of a new file to upload as the video.
Filter by set to true to remove the current video file.
Filter by the file size bytes value for this video file.
Range Filters
Filter by the file size bytes value for this video file greater than or equal to this value.
Filter by the file size bytes value for this video file less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of VideoFile records matching the query. See the Get one VideoFile endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search VideoFiles