Get one EmailTemplateFile

GET

api

sys

emailtemplatefiles

{id}

Get one EmailTemplateFile

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

import requests

url = "https://spaces.nexudus.com/api/sys/emailtemplatefiles/{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/emailtemplatefiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Language": 123,
  "FileLanguageId": 123,
  "Name": "<string>",
  "Subject": "<string>",
  "FileContents": "<string>",
  "IsTextOnly": true,
  "FromName": "<string>",
  "FromEmail": "<string>",
  "CCEmail": "<string>",
  "CCOEmail": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

An EmailTemplateFile defines an email template used for automated communications such as welcome emails, invoices, booking confirmations, and reminders. Templates are language-specific and can be customised per location.

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

Path Parameters

integer

required

The Id of the EmailTemplateFile record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

integer

The language value for this email template file. See eLanguage enum values: 3 = EnglishUK, 1 = EnglishUS, 2 = Spanish.

integer

ID of the file language linked to this record.

string

The name value for this email template file.

string

The subject value for this email template file.

string

The file contents value for this email template file.

boolean

Whether is text only is enabled.

string

The from name value for this email template file.

string

The from email value for this email template file.

string

The cc email value for this email template file.

string

The cco email value for this email 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,
  "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
}

Get multiple EmailTemplateFilesRetrieve multiple EmailTemplateFile records by their Ids in a single request.

Get one EmailTemplateFile

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

import requests

url = "https://spaces.nexudus.com/api/sys/emailtemplatefiles/{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/emailtemplatefiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Language": 123,
  "FileLanguageId": 123,
  "Name": "<string>",
  "Subject": "<string>",
  "FileContents": "<string>",
  "IsTextOnly": true,
  "FromName": "<string>",
  "FromEmail": "<string>",
  "CCEmail": "<string>",
  "CCOEmail": "<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