A DataFile stores a general-purpose file that can be referenced in the members portal, invoices, or email messages and templates sent to customers.
URLs for stored files are public. Use NewFileDataUrl to attach a file from a URL during create or update, and ClearFileDataFile to remove the currently attached file.
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 DataFile-List role.
Query Parameters
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g. Name, CreatedOn).
Sort direction. 1 for ascending, -1 for descending.
Filters
Filter by display name of the file.
Filter by optional description of the file.
DataFile_FileDataFileName
Filter by original filename of the uploaded file.
Filter by public URL pointing to the file to upload. Set during create or update to attach a new file.
Filter by set to true to remove the currently attached file.
Filter by size of the uploaded file in bytes.
Range Filters
from_DataFile_FileSizeBytes
Filter by size of the uploaded file in bytes greater than or equal to this value.
to_DataFile_FileSizeBytes
Filter by size of the uploaded file in bytes 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
curl -X GET \
"https://spaces.nexudus.com/api/content/datafiles?page=1&size=15&orderBy=Name&dir=1" \
-H "Authorization: Bearer YOUR_TOKEN"
Filtering by Name
curl -X GET \
"https://spaces.nexudus.com/api/content/datafiles?DataFile_Name=example-value&orderBy=Name&dir=1" \
-H "Authorization: Bearer YOUR_TOKEN"
Range filters
curl -X GET \
"https://spaces.nexudus.com/api/content/datafiles?from_DataFile_UpdatedOn=2025-01-01T00:00&to_DataFile_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
-H "Authorization: Bearer YOUR_TOKEN"
Response
200
The list of DataFile records matching the query. See the Get one DataFile endpoint for the full list of properties returned for each record.
Number of records per page.
The field used for sorting.
The sort direction (1 = 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.
Whether there is a next page of results.
Whether there is a previous page of results.
{
"Records": [
{
"BusinessId": 0,
"Name": "",
"Description": null,
"FileDataFileName": null,
"NewFileDataUrl": null,
"ClearFileDataFile": 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": "DataFile 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
}