Get one TemplateFile

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>'

import requests

url = "https://spaces.nexudus.com/api/sys/templatefiles/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/templatefiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/templatefiles/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/templatefiles/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

integer

ID of the template version linked to this record.

string

The name value for this template file.

string

The title value for this template file.

string

Free-text description of this template file.

string

Current file name of the picture (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the picture.

boolean

Set to true to remove the current picture file.

string

The permalink value for this template file.

integer

ID of the file language linked to this record.

boolean

Whether published is enabled.

integer

The visibility value for this template file. See eTemplateFileVisibility enum values: 1 = Public, 2 = Private, 3 = PasswordProtected, 4 = OnlyMembers.

string

The password value for this template file.

boolean

Whether is custom is enabled.

string

Display name of the linked theme (read-only).

string

The file contents value for this template file.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple TemplateFilesRetrieve multiple TemplateFile records by their Ids in a single request.

Get one TemplateFile

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/templatefiles/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/templatefiles/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/templatefiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200