Skip to main content
GET
/
api
/
sys
/
templatefiles
/
{id}
Get one TemplateFile
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/templatefiles/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "TemplateVersionId": 123,
  "Name": "<string>",
  "Title": "<string>",
  "Description": "<string>",
  "PictureFileName": "<string>",
  "NewPictureUrl": "<string>",
  "ClearPictureFile": true,
  "Permalink": "<string>",
  "FileLanguageId": 123,
  "Published": true,
  "Visibility": 123,
  "Password": "<string>",
  "IsCustom": true,
  "ThemeName": "<string>",
  "FileContents": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A TemplateFile represents a file asset (HTML, CSS, JavaScript, or image) used in website templates and email templates. Template files control the visual appearance and layout of customer-facing pages.

​
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 TemplateFile-Read role.

​
Path Parameters

​
id
integer
required
The Id of the TemplateFile record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/templatefiles/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
TemplateVersionId
integer
ID of the template version linked to this record.
​
Name
string
The name value for this template file.
​
Title
string
The title value for this template file.
​
Description
string
Free-text description of this template file.
​
PictureFileName
string
Current file name of the picture (read-only; upload via the corresponding URL field).
​
NewPictureUrl
string
URL of a new file to upload as the picture.
​
ClearPictureFile
boolean
Set to true to remove the current picture file.
​
Permalink
string
The permalink value for this template file.
​
FileLanguageId
integer
ID of the file language linked to this record.
​
Published
boolean
Whether published is enabled.
​
Visibility
integer
The visibility value for this template file. See eTemplateFileVisibility enum values: 1 = Public, 2 = Private, 3 = PasswordProtected, 4 = OnlyMembers.
​
Password
string
The password value for this template file.
​
IsCustom
boolean
Whether is custom is enabled.
​
ThemeName
string
Display name of the linked theme (read-only).
​
FileContents
string
The file contents value for this template file.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "TemplateVersionId": null,
  "Name": "",
  "Title": null,
  "Description": null,
  "PictureFileName": null,
  "NewPictureUrl": null,
  "ClearPictureFile": null,
  "Permalink": "",
  "FileLanguageId": null,
  "Published": false,
  "Visibility": 0,
  "Password": null,
  "IsCustom": false,
  "ThemeName": null,
  "FileContents": 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": "TemplateFile Example",
  "LocalizationDetails": null,
  "CustomFields": null
}