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 EmailTemplateFile-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
EmailTemplateFile_Business
Filter by Business Id.
EmailTemplateFile_Language
Filter by Language.
EmailTemplateFile_FileLanguage
Filter by File Language Id.
EmailTemplateFile_Subject
Filter by Subject.
EmailTemplateFile_FileContents
Filter by File Contents.
EmailTemplateFile_IsTextOnly
Filter by Is Text Only.
EmailTemplateFile_FromName
Filter by From Name.
EmailTemplateFile_FromEmail
Filter by From Email.
EmailTemplateFile_CCEmail
Filter by CCEmail.
EmailTemplateFile_CCOEmail
Filter by CCOEmail.
Range Filters
from_EmailTemplateFile_CreatedOn
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
to_EmailTemplateFile_CreatedOn
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
from_EmailTemplateFile_UpdatedOn
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
to_EmailTemplateFile_UpdatedOn
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/sys/emailtemplatefiles?page=1&size=15&orderBy=Name&dir=1" \
-H "Authorization: Bearer YOUR_TOKEN"
Filtering by Name
curl -X GET \
"https://spaces.nexudus.com/api/sys/emailtemplatefiles?EmailTemplateFile_Name=example-value&orderBy=Name&dir=1" \
-H "Authorization: Bearer YOUR_TOKEN"
Range filters
curl -X GET \
"https://spaces.nexudus.com/api/sys/emailtemplatefiles?from_EmailTemplateFile_UpdatedOn=2025-01-01T00:00&to_EmailTemplateFile_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
-H "Authorization: Bearer YOUR_TOKEN"
Response
200
The list of EmailTemplateFile records matching the query. See the Get one EmailTemplateFile endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each EmailTemplateFile. The following fields are not included in the Records[] response: IsTextOnly.To get all fields, fetch the full record using the Get one EmailTemplateFile endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
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,
"Language": 0,
"FileLanguageId": null,
"Name": "",
"Subject": "",
"FileContents": null,
"IsTextOnly": false,
"FromName": null,
"FromEmail": null,
"CCEmail": null,
"CCOEmail": 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": "EmailTemplateFile 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
}