Skip to main content
GET
/
api
/
crm
/
documenttemplates
/
{id}
Get one DocumentTemplate
curl --request GET \
  --url https://spaces.nexudus.com/api/crm/documenttemplates/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "Document": "<string>",
  "BinaryDocumentFileName": "<string>",
  "NewBinaryDocumentUrl": "<string>",
  "ClearBinaryDocumentFile": true,
  "TemplateOutputFormat": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A DocumentTemplate defines a reusable template for generating documents such as contracts, proposals, or invoices. Templates support HTML, Word, and binary output formats and can include dynamic merge fields populated from customer and business data.

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

​
Path Parameters

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

​
Code Examples

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

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
BusinessName
string
Display name of the linked business (read-only).
​
Name
string
The name value for this document template.
​
Document
string
The document value for this document template.
​
BinaryDocumentFileName
string
Current file name of the binary document (read-only; upload via the corresponding URL field).
​
NewBinaryDocumentUrl
string
URL of a new file to upload as the binary document.
​
ClearBinaryDocumentFile
boolean
Set to true to remove the current binary document file.
​
TemplateOutputFormat
integer
The template output format value for this document template. See eDocumentTemplateFormat enum values: 1 = Html, 2 = Word, 3 = Binary.
​
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,
  "BusinessName": null,
  "Name": "",
  "Document": null,
  "BinaryDocumentFileName": null,
  "NewBinaryDocumentUrl": null,
  "ClearBinaryDocumentFile": null,
  "TemplateOutputFormat": 0,
  "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": "DocumentTemplate Example",
  "LocalizationDetails": null,
  "CustomFields": null
}